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 Jul 22 02:12:53 2013 +0000
Revision:
25:a740eb74a86a
Parent:
24:5012a535b1d5
Child:
26:78a1a09afdc9
Improve security, and small formatting changes for more consistency.

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
samux 1:fb4494783863 19 #include "mbed.h"
samux 1:fb4494783863 20 #include "Wifly.h"
samux 1:fb4494783863 21 #include <string>
samux 1:fb4494783863 22 #include <algorithm>
samux 1:fb4494783863 23
WiredHome 25:a740eb74a86a 24 // Defined to disable remote configuration via telnet which increases security of this device.
WiredHome 25:a740eb74a86a 25 #define INCREASE_SECURITY
WiredHome 25:a740eb74a86a 26
WiredHome 20:906b0f951bc3 27 #define DEBUG //Debug is disabled by default
WiredHome 20:906b0f951bc3 28
WiredHome 20:906b0f951bc3 29 #if (defined(DEBUG) && !defined(TARGET_LPC11U24))
WiredHome 20:906b0f951bc3 30 #define DBG(x, ...) std::printf("[DBG Wifly%4d] "x"\r\n", __LINE__, ##__VA_ARGS__);
WiredHome 20:906b0f951bc3 31 #define WARN(x, ...) std::printf("[WRN Wifly%4d] "x"\r\n", __LINE__, ##__VA_ARGS__);
WiredHome 20:906b0f951bc3 32 #define ERR(x, ...) std::printf("[ERR Wifly%4d] "x"\r\n", __LINE__, ##__VA_ARGS__);
WiredHome 20:906b0f951bc3 33 #define INFO(x, ...) std::printf("[INF Wifly%4d] "x"\r\n", __LINE__, ##__VA_ARGS__);
samux 1:fb4494783863 34 #else
samux 1:fb4494783863 35 #define DBG(x, ...)
samux 1:fb4494783863 36 #define WARN(x, ...)
samux 1:fb4494783863 37 #define ERR(x, ...)
WiredHome 20:906b0f951bc3 38 #define INFO(x, ...)
samux 1:fb4494783863 39 #endif
samux 1:fb4494783863 40
samux 1:fb4494783863 41 #define MAX_TRY_JOIN 3
samux 1:fb4494783863 42
samux 1:fb4494783863 43 Wifly * Wifly::inst;
samux 1:fb4494783863 44
samux 1:fb4494783863 45 Wifly::Wifly( PinName tx, PinName rx, PinName _reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec):
WiredHome 20:906b0f951bc3 46 wifi(tx, rx), reset_pin(_reset), tcp_status(tcp_status), baudrate(9600), buf_wifly(256)
samux 1:fb4494783863 47 {
samux 1:fb4494783863 48 memset(&state, 0, sizeof(state));
samux 1:fb4494783863 49 state.sec = sec;
samux 1:fb4494783863 50
WiredHome 24:5012a535b1d5 51 FixPhrase(&this->ssid, ssid);
WiredHome 24:5012a535b1d5 52 FixPhrase(&this->phrase, phrase);
samux 1:fb4494783863 53
samux 1:fb4494783863 54 inst = this;
samux 1:fb4494783863 55 attach_rx(false);
samux 1:fb4494783863 56 state.cmd_mode = false;
WiredHome 25:a740eb74a86a 57 wiflyVersionString = NULL;
samux 1:fb4494783863 58 }
samux 1:fb4494783863 59
WiredHome 25:a740eb74a86a 60
WiredHome 25:a740eb74a86a 61 Wifly::~Wifly()
WiredHome 25:a740eb74a86a 62 {
WiredHome 25:a740eb74a86a 63 if (ssid) {
WiredHome 25:a740eb74a86a 64 free(ssid);
WiredHome 25:a740eb74a86a 65 ssid = NULL;
WiredHome 25:a740eb74a86a 66 }
WiredHome 25:a740eb74a86a 67 if (phrase) {
WiredHome 25:a740eb74a86a 68 free(phrase);
WiredHome 25:a740eb74a86a 69 phrase = NULL;
WiredHome 25:a740eb74a86a 70 }
WiredHome 25:a740eb74a86a 71 if (wiflyVersionString) {
WiredHome 25:a740eb74a86a 72 free(wiflyVersionString);
WiredHome 25:a740eb74a86a 73 wiflyVersionString = NULL;
WiredHome 25:a740eb74a86a 74 }
WiredHome 25:a740eb74a86a 75 }
WiredHome 25:a740eb74a86a 76
WiredHome 25:a740eb74a86a 77
samux 1:fb4494783863 78 bool Wifly::join()
samux 1:fb4494783863 79 {
samux 1:fb4494783863 80 char cmd[20];
samux 1:fb4494783863 81
samux 1:fb4494783863 82 for (int i= 0; i < MAX_TRY_JOIN; i++) {
samux 2:8e54830d0df7 83
samux 2:8e54830d0df7 84 // no auto join
samux 2:8e54830d0df7 85 if (!sendCommand("set w j 0\r", "AOK"))
samux 2:8e54830d0df7 86 continue;
samux 2:8e54830d0df7 87
samux 2:8e54830d0df7 88 //no echo
samux 2:8e54830d0df7 89 if (!sendCommand("set u m 1\r", "AOK"))
samux 2:8e54830d0df7 90 continue;
samux 2:8e54830d0df7 91
samux 1:fb4494783863 92 // set time
samux 4:0bcec6272784 93 if (!sendCommand("set c t 30\r", "AOK"))
samux 1:fb4494783863 94 continue;
samux 1:fb4494783863 95
samux 1:fb4494783863 96 // set size
samux 4:0bcec6272784 97 if (!sendCommand("set c s 1024\r", "AOK"))
samux 1:fb4494783863 98 continue;
samux 1:fb4494783863 99
samux 1:fb4494783863 100 // red led on when tcp connection active
samux 1:fb4494783863 101 if (!sendCommand("set s i 0x40\r", "AOK"))
samux 1:fb4494783863 102 continue;
samux 1:fb4494783863 103
samux 1:fb4494783863 104 // no string sent to the tcp client
samux 1:fb4494783863 105 if (!sendCommand("set c r 0\r", "AOK"))
samux 1:fb4494783863 106 continue;
samux 1:fb4494783863 107
samux 1:fb4494783863 108 // tcp protocol
samux 1:fb4494783863 109 if (!sendCommand("set i p 2\r", "AOK"))
samux 1:fb4494783863 110 continue;
samux 1:fb4494783863 111
samux 1:fb4494783863 112 // tcp retry
samux 1:fb4494783863 113 if (!sendCommand("set i f 0x7\r", "AOK"))
samux 1:fb4494783863 114 continue;
WiredHome 20:906b0f951bc3 115
WiredHome 25:a740eb74a86a 116 #ifdef INCREASE_SECURITY
WiredHome 25:a740eb74a86a 117 // tcp-mode 0x10 = disable remote configuration
WiredHome 25:a740eb74a86a 118 // only in SW 2.27 and higher (see 2.3.39)
WiredHome 25:a740eb74a86a 119 if ((swVersion >= 2.27) && (!sendCommand("set i t 0x10\r", "AOK")))
WiredHome 25:a740eb74a86a 120 continue;
WiredHome 25:a740eb74a86a 121 #endif
WiredHome 25:a740eb74a86a 122
samux 2:8e54830d0df7 123 // set dns server
samux 2:8e54830d0df7 124 if (!sendCommand("set d n rn.microchip.com\r", "AOK"))
samux 1:fb4494783863 125 continue;
samux 1:fb4494783863 126
samux 1:fb4494783863 127 //dhcp
samux 1:fb4494783863 128 sprintf(cmd, "set i d %d\r", (state.dhcp) ? 1 : 0);
samux 1:fb4494783863 129 if (!sendCommand(cmd, "AOK"))
samux 1:fb4494783863 130 continue;
samux 1:fb4494783863 131
samux 1:fb4494783863 132 // ssid
samux 1:fb4494783863 133 sprintf(cmd, "set w s %s\r", ssid);
samux 1:fb4494783863 134 if (!sendCommand(cmd, "AOK"))
samux 1:fb4494783863 135 continue;
samux 1:fb4494783863 136
samux 1:fb4494783863 137 //auth
samux 1:fb4494783863 138 sprintf(cmd, "set w a %d\r", state.sec);
samux 1:fb4494783863 139 if (!sendCommand(cmd, "AOK"))
samux 1:fb4494783863 140 continue;
samux 1:fb4494783863 141
samux 1:fb4494783863 142 // if no dhcp, set ip, netmask and gateway
samux 1:fb4494783863 143 if (!state.dhcp) {
WiredHome 20:906b0f951bc3 144 DBG("not dhcp");
samux 1:fb4494783863 145
samux 1:fb4494783863 146 sprintf(cmd, "set i a %s\r\n", ip);
samux 1:fb4494783863 147 if (!sendCommand(cmd, "AOK"))
samux 1:fb4494783863 148 continue;
samux 1:fb4494783863 149
samux 1:fb4494783863 150 sprintf(cmd, "set i n %s\r", netmask);
samux 1:fb4494783863 151 if (!sendCommand(cmd, "AOK"))
samux 1:fb4494783863 152 continue;
samux 1:fb4494783863 153
samux 1:fb4494783863 154 sprintf(cmd, "set i g %s\r", gateway);
samux 1:fb4494783863 155 if (!sendCommand(cmd, "AOK"))
samux 1:fb4494783863 156 continue;
samux 1:fb4494783863 157 }
samux 1:fb4494783863 158
samux 1:fb4494783863 159 //key step
samux 1:fb4494783863 160 if (state.sec != NONE) {
samux 1:fb4494783863 161 if (state.sec == WPA)
samux 1:fb4494783863 162 sprintf(cmd, "set w p %s\r", phrase);
samux 1:fb4494783863 163 else if (state.sec == WEP_128)
samux 1:fb4494783863 164 sprintf(cmd, "set w k %s\r", phrase);
samux 1:fb4494783863 165
samux 1:fb4494783863 166 if (!sendCommand(cmd, "AOK"))
samux 1:fb4494783863 167 continue;
samux 1:fb4494783863 168 }
samux 1:fb4494783863 169
samux 2:8e54830d0df7 170 //join the network (10s timeout)
samux 1:fb4494783863 171 if (state.dhcp) {
samux 2:8e54830d0df7 172 if (!sendCommand("join\r", "DHCP=ON", NULL, 10000))
samux 2:8e54830d0df7 173 continue;
samux 2:8e54830d0df7 174 } else {
samux 2:8e54830d0df7 175 if (!sendCommand("join\r", "Associated", NULL, 10000))
samux 1:fb4494783863 176 continue;
samux 1:fb4494783863 177 }
samux 1:fb4494783863 178
samux 2:8e54830d0df7 179 if (!sendCommand("save\r", "Stor"))
samux 2:8e54830d0df7 180 continue;
samux 2:8e54830d0df7 181
samux 1:fb4494783863 182 exit();
samux 1:fb4494783863 183
samux 1:fb4494783863 184 state.associated = true;
samux 1:fb4494783863 185 INFO("\r\nssid: %s\r\nphrase: %s\r\nsecurity: %s\r\n\r\n", this->ssid, this->phrase, getStringSecurity());
samux 1:fb4494783863 186 return true;
samux 1:fb4494783863 187 }
samux 1:fb4494783863 188 return false;
samux 1:fb4494783863 189 }
samux 1:fb4494783863 190
samux 1:fb4494783863 191
samux 1:fb4494783863 192 bool Wifly::setProtocol(Protocol p)
samux 1:fb4494783863 193 {
samux 1:fb4494783863 194 // use udp auto pairing
samux 1:fb4494783863 195 char cmd[20];
samux 1:fb4494783863 196 sprintf(cmd, "set i p %d\r", p);
samux 1:fb4494783863 197 if (!sendCommand(cmd, "AOK"))
samux 1:fb4494783863 198 return false;
samux 1:fb4494783863 199
samux 1:fb4494783863 200 switch(p) {
samux 1:fb4494783863 201 case TCP:
samux 1:fb4494783863 202 // set ip flags: tcp retry enabled
samux 1:fb4494783863 203 if (!sendCommand("set i f 0x07\r", "AOK"))
samux 1:fb4494783863 204 return false;
samux 1:fb4494783863 205 break;
samux 1:fb4494783863 206 case UDP:
samux 1:fb4494783863 207 // set ip flags: udp auto pairing enabled
samux 1:fb4494783863 208 if (!sendCommand("set i h 0.0.0.0\r", "AOK"))
samux 1:fb4494783863 209 return false;
samux 4:0bcec6272784 210 if (!sendCommand("set i f 0x40\r", "AOK"))
samux 1:fb4494783863 211 return false;
samux 1:fb4494783863 212 break;
samux 1:fb4494783863 213 }
samux 1:fb4494783863 214 state.proto = p;
samux 1:fb4494783863 215 return true;
samux 1:fb4494783863 216 }
samux 1:fb4494783863 217
WiredHome 25:a740eb74a86a 218
samux 1:fb4494783863 219 char * Wifly::getStringSecurity()
samux 1:fb4494783863 220 {
samux 1:fb4494783863 221 switch(state.sec) {
samux 1:fb4494783863 222 case NONE:
samux 1:fb4494783863 223 return "NONE";
samux 1:fb4494783863 224 case WEP_128:
samux 1:fb4494783863 225 return "WEP_128";
samux 1:fb4494783863 226 case WPA:
samux 1:fb4494783863 227 return "WPA";
samux 1:fb4494783863 228 }
samux 1:fb4494783863 229 return "UNKNOWN";
samux 1:fb4494783863 230 }
samux 1:fb4494783863 231
WiredHome 25:a740eb74a86a 232
samux 1:fb4494783863 233 bool Wifly::connect(const char * host, int port)
samux 1:fb4494783863 234 {
samux 1:fb4494783863 235 char rcv[20];
samux 1:fb4494783863 236 char cmd[20];
samux 1:fb4494783863 237
samux 2:8e54830d0df7 238 // try to open
samux 2:8e54830d0df7 239 sprintf(cmd, "open %s %d\r", host, port);
samux 2:8e54830d0df7 240 if (sendCommand(cmd, "OPEN", NULL, 10000)) {
samux 2:8e54830d0df7 241 state.tcp = true;
WiredHome 25:a740eb74a86a 242 exit();
samux 2:8e54830d0df7 243 return true;
samux 1:fb4494783863 244 }
samux 1:fb4494783863 245
samux 2:8e54830d0df7 246 // if failed, retry and parse the response
samux 2:8e54830d0df7 247 if (sendCommand(cmd, NULL, rcv, 5000)) {
samux 1:fb4494783863 248 if (strstr(rcv, "OPEN") == NULL) {
samux 1:fb4494783863 249 if (strstr(rcv, "Connected") != NULL) {
samux 1:fb4494783863 250 if (!sendCommand("close\r", "CLOS"))
samux 1:fb4494783863 251 return false;
samux 2:8e54830d0df7 252 if (!sendCommand(cmd, "OPEN", NULL, 10000))
samux 1:fb4494783863 253 return false;
samux 1:fb4494783863 254 } else {
samux 1:fb4494783863 255 return false;
samux 1:fb4494783863 256 }
samux 1:fb4494783863 257 }
samux 1:fb4494783863 258 } else {
samux 1:fb4494783863 259 return false;
samux 1:fb4494783863 260 }
samux 2:8e54830d0df7 261
samux 1:fb4494783863 262 state.tcp = true;
WiredHome 25:a740eb74a86a 263 exit();
samux 1:fb4494783863 264 return true;
samux 1:fb4494783863 265 }
samux 1:fb4494783863 266
samux 1:fb4494783863 267
samux 1:fb4494783863 268 bool Wifly::gethostbyname(const char * host, char * ip)
samux 1:fb4494783863 269 {
samux 1:fb4494783863 270 string h = host;
samux 1:fb4494783863 271 char cmd[30], rcv[100];
samux 1:fb4494783863 272 int l = 0;
samux 1:fb4494783863 273 char * point;
samux 1:fb4494783863 274 int nb_digits = 0;
samux 1:fb4494783863 275
samux 1:fb4494783863 276 // no dns needed
samux 1:fb4494783863 277 int pos = h.find(".");
samux 1:fb4494783863 278 if (pos != string::npos) {
samux 1:fb4494783863 279 string sub = h.substr(0, h.find("."));
samux 1:fb4494783863 280 nb_digits = atoi(sub.c_str());
samux 1:fb4494783863 281 }
samux 1:fb4494783863 282 //printf("substrL %s\r\n", sub.c_str());
samux 1:fb4494783863 283 if (count(h.begin(), h.end(), '.') == 3 && nb_digits > 0) {
samux 1:fb4494783863 284 strcpy(ip, host);
samux 1:fb4494783863 285 }
samux 1:fb4494783863 286 // dns needed
samux 1:fb4494783863 287 else {
samux 1:fb4494783863 288 nb_digits = 0;
samux 1:fb4494783863 289 sprintf(cmd, "lookup %s\r", host);
samux 1:fb4494783863 290 if (!sendCommand(cmd, NULL, rcv))
samux 1:fb4494783863 291 return false;
samux 1:fb4494783863 292
samux 1:fb4494783863 293 // look for the ip address
samux 1:fb4494783863 294 char * begin = strstr(rcv, "=") + 1;
samux 1:fb4494783863 295 for (int i = 0; i < 3; i++) {
samux 1:fb4494783863 296 point = strstr(begin + l, ".");
samux 1:fb4494783863 297 DBG("str: %s", begin + l);
samux 1:fb4494783863 298 l += point - (begin + l) + 1;
samux 1:fb4494783863 299 }
samux 1:fb4494783863 300 DBG("str: %s", begin + l);
samux 1:fb4494783863 301 while(*(begin + l + nb_digits) >= '0' && *(begin + l + nb_digits) <= '9') {
samux 1:fb4494783863 302 DBG("digit: %c", *(begin + l + nb_digits));
samux 1:fb4494783863 303 nb_digits++;
samux 1:fb4494783863 304 }
samux 1:fb4494783863 305 memcpy(ip, begin, l + nb_digits);
samux 1:fb4494783863 306 ip[l+nb_digits] = 0;
samux 1:fb4494783863 307 DBG("ip from dns: %s", ip);
samux 1:fb4494783863 308 }
samux 1:fb4494783863 309 return true;
samux 1:fb4494783863 310 }
samux 1:fb4494783863 311
samux 1:fb4494783863 312
samux 1:fb4494783863 313 void Wifly::flush()
samux 1:fb4494783863 314 {
samux 1:fb4494783863 315 buf_wifly.flush();
samux 1:fb4494783863 316 }
samux 1:fb4494783863 317
WiredHome 25:a740eb74a86a 318
samux 1:fb4494783863 319 bool Wifly::sendCommand(const char * cmd, const char * ack, char * res, int timeout)
samux 1:fb4494783863 320 {
WiredHome 20:906b0f951bc3 321 int tries = 1;
WiredHome 20:906b0f951bc3 322
samux 1:fb4494783863 323 if (!state.cmd_mode) {
samux 1:fb4494783863 324 cmdMode();
samux 1:fb4494783863 325 }
WiredHome 20:906b0f951bc3 326 while (tries <= 2) {
WiredHome 20:906b0f951bc3 327 DBG("sendCommand() try: %d, this: %s", tries, cmd);
WiredHome 20:906b0f951bc3 328 if (send(cmd, strlen(cmd), ack, res, timeout) >= 0) {
WiredHome 20:906b0f951bc3 329 return true;
WiredHome 20:906b0f951bc3 330 }
WiredHome 20:906b0f951bc3 331 tries++;
samux 1:fb4494783863 332 }
WiredHome 20:906b0f951bc3 333 ERR("sendCommand: failed: %s", cmd);
WiredHome 17:213844a1864f 334 return false;
samux 1:fb4494783863 335 }
samux 1:fb4494783863 336
WiredHome 25:a740eb74a86a 337
samux 1:fb4494783863 338 bool Wifly::cmdMode()
samux 1:fb4494783863 339 {
samux 1:fb4494783863 340 // if already in cmd mode, return
samux 1:fb4494783863 341 if (state.cmd_mode)
samux 1:fb4494783863 342 return true;
samux 2:8e54830d0df7 343
WiredHome 25:a740eb74a86a 344 wait_ms(250); // manual 1.2.1 (250 msec before and after)
samux 1:fb4494783863 345 if (send("$$$", 3, "CMD") == -1) {
samux 1:fb4494783863 346 ERR("cannot enter in cmd mode\r\n");
samux 2:8e54830d0df7 347 exit();
samux 1:fb4494783863 348 return false;
samux 1:fb4494783863 349 }
samux 1:fb4494783863 350 state.cmd_mode = true;
samux 1:fb4494783863 351 return true;
samux 1:fb4494783863 352 }
samux 1:fb4494783863 353
WiredHome 25:a740eb74a86a 354
samux 1:fb4494783863 355 bool Wifly::disconnect()
samux 1:fb4494783863 356 {
samux 1:fb4494783863 357 // if already disconnected, return
samux 1:fb4494783863 358 if (!state.associated)
samux 1:fb4494783863 359 return true;
samux 2:8e54830d0df7 360
samux 1:fb4494783863 361 if (!sendCommand("leave\r", "DeAuth"))
samux 1:fb4494783863 362 return false;
samux 1:fb4494783863 363 exit();
samux 2:8e54830d0df7 364
samux 1:fb4494783863 365 state.associated = false;
samux 1:fb4494783863 366 return true;
samux 1:fb4494783863 367
samux 1:fb4494783863 368 }
samux 1:fb4494783863 369
WiredHome 25:a740eb74a86a 370
samux 1:fb4494783863 371 bool Wifly::is_connected()
samux 1:fb4494783863 372 {
samux 1:fb4494783863 373 return (tcp_status.read() == 1) ? true : false;
samux 1:fb4494783863 374 }
samux 1:fb4494783863 375
samux 1:fb4494783863 376
samux 1:fb4494783863 377 void Wifly::reset()
samux 1:fb4494783863 378 {
samux 1:fb4494783863 379 reset_pin = 0;
WiredHome 25:a740eb74a86a 380 wifi.baud(9600);
WiredHome 25:a740eb74a86a 381 wait_ms(200);
samux 1:fb4494783863 382 reset_pin = 1;
WiredHome 25:a740eb74a86a 383 GatherLogonInfo();
samux 1:fb4494783863 384 }
samux 1:fb4494783863 385
WiredHome 25:a740eb74a86a 386
samux 3:9aa05e19c62e 387 bool Wifly::reboot()
samux 3:9aa05e19c62e 388 {
samux 3:9aa05e19c62e 389 // if already in cmd mode, return
samux 3:9aa05e19c62e 390 if (!sendCommand("reboot\r"))
samux 3:9aa05e19c62e 391 return false;
WiredHome 25:a740eb74a86a 392 wait_ms(300);
WiredHome 25:a740eb74a86a 393 wifi.baud(9600);
WiredHome 25:a740eb74a86a 394 baud(baudrate);
WiredHome 25:a740eb74a86a 395 exit();
samux 3:9aa05e19c62e 396 return true;
samux 3:9aa05e19c62e 397 }
samux 3:9aa05e19c62e 398
WiredHome 25:a740eb74a86a 399
samux 1:fb4494783863 400 bool Wifly::close()
samux 1:fb4494783863 401 {
samux 1:fb4494783863 402 // if not connected, return
samux 1:fb4494783863 403 if (!state.tcp)
samux 1:fb4494783863 404 return true;
samux 2:8e54830d0df7 405
samux 1:fb4494783863 406 if (!sendCommand("close\r", "CLOS"))
samux 1:fb4494783863 407 return false;
samux 1:fb4494783863 408 exit();
samux 2:8e54830d0df7 409
samux 1:fb4494783863 410 state.tcp = false;
samux 1:fb4494783863 411 return true;
samux 1:fb4494783863 412 }
samux 1:fb4494783863 413
samux 1:fb4494783863 414
samux 1:fb4494783863 415 int Wifly::putc(char c)
samux 1:fb4494783863 416 {
WiredHome 25:a740eb74a86a 417 while (!wifi.writeable())
WiredHome 25:a740eb74a86a 418 ;
samux 1:fb4494783863 419 return wifi.putc(c);
samux 1:fb4494783863 420 }
samux 1:fb4494783863 421
samux 1:fb4494783863 422
samux 1:fb4494783863 423 bool Wifly::exit()
samux 1:fb4494783863 424 {
samux 1:fb4494783863 425 if (!sendCommand("exit\r", "EXIT"))
samux 1:fb4494783863 426 return false;
samux 1:fb4494783863 427 state.cmd_mode = false;
samux 1:fb4494783863 428 return true;
samux 1:fb4494783863 429 }
samux 1:fb4494783863 430
samux 1:fb4494783863 431
samux 1:fb4494783863 432 int Wifly::readable()
samux 1:fb4494783863 433 {
samux 1:fb4494783863 434 return buf_wifly.available();
samux 1:fb4494783863 435 }
samux 1:fb4494783863 436
WiredHome 25:a740eb74a86a 437
samux 1:fb4494783863 438 int Wifly::writeable()
samux 1:fb4494783863 439 {
samux 1:fb4494783863 440 return wifi.writeable();
samux 1:fb4494783863 441 }
samux 1:fb4494783863 442
WiredHome 25:a740eb74a86a 443
samux 1:fb4494783863 444 char Wifly::getc()
samux 1:fb4494783863 445 {
samux 1:fb4494783863 446 char c;
WiredHome 25:a740eb74a86a 447 while (!buf_wifly.available())
WiredHome 25:a740eb74a86a 448 ;
samux 1:fb4494783863 449 buf_wifly.dequeue(&c);
samux 1:fb4494783863 450 return c;
samux 1:fb4494783863 451 }
samux 1:fb4494783863 452
WiredHome 25:a740eb74a86a 453
samux 1:fb4494783863 454 void Wifly::handler_rx(void)
samux 1:fb4494783863 455 {
samux 1:fb4494783863 456 //read characters
samux 1:fb4494783863 457 while (wifi.readable())
samux 1:fb4494783863 458 buf_wifly.queue(wifi.getc());
samux 1:fb4494783863 459 }
samux 1:fb4494783863 460
WiredHome 25:a740eb74a86a 461
samux 1:fb4494783863 462 void Wifly::attach_rx(bool callback)
samux 1:fb4494783863 463 {
samux 1:fb4494783863 464 if (!callback)
samux 1:fb4494783863 465 wifi.attach(NULL);
samux 1:fb4494783863 466 else
samux 1:fb4494783863 467 wifi.attach(this, &Wifly::handler_rx);
samux 1:fb4494783863 468 }
samux 1:fb4494783863 469
samux 1:fb4494783863 470
samux 1:fb4494783863 471 int Wifly::send(const char * str, int len, const char * ACK, char * res, int timeout)
samux 1:fb4494783863 472 {
samux 1:fb4494783863 473 char read;
samux 1:fb4494783863 474 size_t found = string::npos;
samux 1:fb4494783863 475 string checking;
samux 1:fb4494783863 476 Timer tmr;
samux 1:fb4494783863 477 int result = 0;
samux 1:fb4494783863 478
WiredHome 20:906b0f951bc3 479 DBG("send in %d ms this: %s", timeout, str);
samux 1:fb4494783863 480 attach_rx(false);
WiredHome 18:18ab3993d00d 481 flushIn();
WiredHome 20:906b0f951bc3 482 tmr.start();
samux 1:fb4494783863 483 if (!ACK || !strcmp(ACK, "NO")) {
samux 1:fb4494783863 484 for (int i = 0; i < len; i++)
samux 1:fb4494783863 485 result = (putc(str[i]) == str[i]) ? result + 1 : result;
samux 1:fb4494783863 486 } else {
samux 1:fb4494783863 487 for (int i = 0; i < len; i++)
samux 1:fb4494783863 488 result = (putc(str[i]) == str[i]) ? result + 1 : result;
samux 1:fb4494783863 489
samux 1:fb4494783863 490 while (1) {
samux 1:fb4494783863 491 if (tmr.read_ms() > timeout) {
WiredHome 18:18ab3993d00d 492 flushIn();
WiredHome 20:906b0f951bc3 493 DBG("check: %s", checking.c_str());
samux 1:fb4494783863 494 attach_rx(true);
samux 1:fb4494783863 495 return -1;
samux 1:fb4494783863 496 } else if (wifi.readable()) {
samux 1:fb4494783863 497 read = wifi.getc();
samux 1:fb4494783863 498 if ( read != '\r' && read != '\n') {
samux 1:fb4494783863 499 checking += read;
samux 1:fb4494783863 500 found = checking.find(ACK);
samux 1:fb4494783863 501 if (found != string::npos) {
WiredHome 18:18ab3993d00d 502 flushIn(10);
samux 1:fb4494783863 503 break;
samux 1:fb4494783863 504 }
samux 1:fb4494783863 505 }
samux 1:fb4494783863 506 }
samux 1:fb4494783863 507 }
WiredHome 20:906b0f951bc3 508 DBG("check: %s", checking.c_str());
samux 1:fb4494783863 509 attach_rx(true);
samux 1:fb4494783863 510 return result;
samux 1:fb4494783863 511 }
samux 1:fb4494783863 512
samux 1:fb4494783863 513 //the user wants the result from the command (ACK == NULL, res != NULL)
samux 1:fb4494783863 514 if ( res != NULL) {
samux 1:fb4494783863 515 int i = 0;
samux 1:fb4494783863 516 while (1) {
WiredHome 19:b0c2488222a3 517 if (tmr.read_ms() > timeout) {
WiredHome 19:b0c2488222a3 518 res[i] = '\0';
samux 1:fb4494783863 519 if (i == 0) {
samux 1:fb4494783863 520 res = NULL;
samux 1:fb4494783863 521 }
WiredHome 23:6e77c65ced00 522 DBG("timed out");
samux 1:fb4494783863 523 break;
samux 1:fb4494783863 524 } else {
samux 1:fb4494783863 525 if (wifi.readable()) {
samux 1:fb4494783863 526 read = wifi.getc();
WiredHome 25:a740eb74a86a 527 // we drop \r and \n, but should we since it is for user code...
samux 1:fb4494783863 528 if ( read != '\r' && read != '\n') {
samux 1:fb4494783863 529 res[i++] = read;
samux 1:fb4494783863 530 }
samux 1:fb4494783863 531 }
samux 1:fb4494783863 532 }
samux 1:fb4494783863 533 }
WiredHome 20:906b0f951bc3 534 DBG("user str: %s", res);
samux 1:fb4494783863 535 }
samux 1:fb4494783863 536
WiredHome 18:18ab3993d00d 537 flushIn();
samux 1:fb4494783863 538 attach_rx(true);
WiredHome 20:906b0f951bc3 539 DBG("result: %d", result)
samux 1:fb4494783863 540 return result;
WiredHome 18:18ab3993d00d 541 }
WiredHome 18:18ab3993d00d 542
WiredHome 19:b0c2488222a3 543
WiredHome 18:18ab3993d00d 544 void Wifly::flushIn(int timeout_ms)
WiredHome 18:18ab3993d00d 545 {
WiredHome 18:18ab3993d00d 546 Timer tmr;
WiredHome 18:18ab3993d00d 547 #ifdef DEBUG
WiredHome 18:18ab3993d00d 548 char chatter[500];
WiredHome 18:18ab3993d00d 549 int count = 0;
WiredHome 18:18ab3993d00d 550 int c;
WiredHome 18:18ab3993d00d 551 #endif
WiredHome 18:18ab3993d00d 552
WiredHome 18:18ab3993d00d 553 if (timeout_ms == 0) {
WiredHome 25:a740eb74a86a 554 timeout_ms = 2 * 10000 / baudrate; // compute minimal timeout
WiredHome 25:a740eb74a86a 555 if (timeout_ms < 2)
WiredHome 25:a740eb74a86a 556 timeout_ms = 2;
WiredHome 18:18ab3993d00d 557 }
WiredHome 18:18ab3993d00d 558 tmr.start();
WiredHome 18:18ab3993d00d 559 while (wifi.readable() || (tmr.read_ms() < timeout_ms)) {
WiredHome 18:18ab3993d00d 560 if (wifi.readable()) {
WiredHome 18:18ab3993d00d 561 #ifndef DEBUG
WiredHome 18:18ab3993d00d 562 wifi.getc();
WiredHome 18:18ab3993d00d 563 #else
WiredHome 18:18ab3993d00d 564 c = wifi.getc();
WiredHome 18:18ab3993d00d 565 if (c != '\r' && c != '\n')
WiredHome 18:18ab3993d00d 566 chatter[count++] = c;
WiredHome 18:18ab3993d00d 567 #endif
WiredHome 18:18ab3993d00d 568 tmr.reset();
WiredHome 18:18ab3993d00d 569 tmr.start(); // start should not be necessary
WiredHome 18:18ab3993d00d 570 }
WiredHome 18:18ab3993d00d 571 }
WiredHome 18:18ab3993d00d 572 #ifdef DEBUG
WiredHome 18:18ab3993d00d 573 chatter[count] = '\0';
WiredHome 18:18ab3993d00d 574 DBG("Wifly::flushIn(%d) {%s}", timeout_ms, chatter);
WiredHome 18:18ab3993d00d 575 #endif
WiredHome 18:18ab3993d00d 576 }
WiredHome 20:906b0f951bc3 577
WiredHome 20:906b0f951bc3 578
WiredHome 20:906b0f951bc3 579 // The ARM uart and the Wifly uart have to be in sync or we get
WiredHome 20:906b0f951bc3 580 // no meaningful response, so then have to try the possibilities.
WiredHome 20:906b0f951bc3 581 //
WiredHome 20:906b0f951bc3 582 // First try is at the currently configured ARM uart baud, if
WiredHome 20:906b0f951bc3 583 // that fails then it shifts the ARM uart baud through the probable
WiredHome 20:906b0f951bc3 584 // speeds, trying to establish contact with the Wifly module.
WiredHome 20:906b0f951bc3 585 // Once contact is demonstrated (response to the 'ver' command),
WiredHome 20:906b0f951bc3 586 // then it sets the Wifly module and then the ARM uart.
WiredHome 20:906b0f951bc3 587 bool Wifly::baud(int _targetBaud)
WiredHome 20:906b0f951bc3 588 {
WiredHome 20:906b0f951bc3 589 // in testing, 460800 and 921600 may change the Wifly module where you can't
WiredHome 20:906b0f951bc3 590 // change it back w/o a reset. So, we won't even permit those speeds.
WiredHome 20:906b0f951bc3 591 const int baudrates[] = {2400, 4800, 9600, 19200, 38400, 57600, 115200, 230400}; //, 460800, 921600};
WiredHome 20:906b0f951bc3 592 #define BRCOUNT (sizeof(baudrates)/sizeof(baudrates[0]))
WiredHome 20:906b0f951bc3 593 char cmd[20]; // sized for "set u i 460800\r" [15+1], plus margin [4]
WiredHome 20:906b0f951bc3 594 int tryIndex = 0;
WiredHome 20:906b0f951bc3 595 bool res = false;
WiredHome 20:906b0f951bc3 596 int userIndex;
WiredHome 20:906b0f951bc3 597
WiredHome 20:906b0f951bc3 598 sprintf(cmd, "set u i %d\r", _targetBaud);
WiredHome 20:906b0f951bc3 599 // set u i # should cause it to exit command mode (manual 2.3.64),
WiredHome 20:906b0f951bc3 600 // but testing indicates that it does not.
WiredHome 20:906b0f951bc3 601 for (userIndex=0; userIndex < BRCOUNT; userIndex++) {
WiredHome 20:906b0f951bc3 602 if (_targetBaud == baudrates[userIndex]) {
WiredHome 20:906b0f951bc3 603 while (tryIndex <= BRCOUNT) {
WiredHome 20:906b0f951bc3 604 DBG("baud(%d) try: %d", _targetBaud, tryIndex);
WiredHome 20:906b0f951bc3 605 sendCommand(cmd); // shift Wifly to desired speed [it may not respond (see 2.3.64)]
WiredHome 20:906b0f951bc3 606 // state.cmd_mode = false; // see note above why this is disabled
WiredHome 20:906b0f951bc3 607 wifi.baud(_targetBaud); // shift the ARM uart to match
WiredHome 20:906b0f951bc3 608 if (sendCommand("ver\r", "wifly", NULL, timeToRespond(4))) { // use this to verify communications
WiredHome 20:906b0f951bc3 609 baudrate = _targetBaud;
WiredHome 20:906b0f951bc3 610 res = true;
WiredHome 20:906b0f951bc3 611 break; // success
WiredHome 20:906b0f951bc3 612 }
WiredHome 20:906b0f951bc3 613 // keep trying baudrates between ARM and WiFly
WiredHome 20:906b0f951bc3 614 if (tryIndex < BRCOUNT) {
WiredHome 20:906b0f951bc3 615 wifi.baud(baudrates[tryIndex]);
WiredHome 20:906b0f951bc3 616 }
WiredHome 20:906b0f951bc3 617 tryIndex++;
WiredHome 20:906b0f951bc3 618 }
WiredHome 20:906b0f951bc3 619 break; // if they selected a legitimate baud, try no others
WiredHome 20:906b0f951bc3 620 }
WiredHome 20:906b0f951bc3 621 }
WiredHome 20:906b0f951bc3 622 return res;
WiredHome 20:906b0f951bc3 623 }
WiredHome 20:906b0f951bc3 624
WiredHome 25:a740eb74a86a 625
WiredHome 20:906b0f951bc3 626 int Wifly::timeToRespond(int stringLen)
WiredHome 20:906b0f951bc3 627 {
WiredHome 20:906b0f951bc3 628 return 150 + (1 | 10000/baudrate) * stringLen;
WiredHome 21:97294686b4a1 629 }
WiredHome 23:6e77c65ced00 630
WiredHome 24:5012a535b1d5 631
WiredHome 24:5012a535b1d5 632 void Wifly::FixPhrase(char ** dst, const char * src)
WiredHome 24:5012a535b1d5 633 {
WiredHome 24:5012a535b1d5 634 // change all ' ' in '$' in the ssid and the passphrase
WiredHome 24:5012a535b1d5 635 *dst = (char *)malloc(strlen(src)+1);
WiredHome 24:5012a535b1d5 636 if (*dst) {
WiredHome 24:5012a535b1d5 637 strcpy(*dst, src);
WiredHome 24:5012a535b1d5 638 for (int i = 0; i < strlen(*dst); i++) {
WiredHome 24:5012a535b1d5 639 if ((*dst)[i] == ' ')
WiredHome 24:5012a535b1d5 640 (*dst)[i] = '$';
WiredHome 24:5012a535b1d5 641 }
WiredHome 24:5012a535b1d5 642 } else {
WiredHome 24:5012a535b1d5 643 *dst = NULL;
WiredHome 24:5012a535b1d5 644 }
WiredHome 24:5012a535b1d5 645 }
WiredHome 25:a740eb74a86a 646
WiredHome 25:a740eb74a86a 647
WiredHome 25:a740eb74a86a 648 void Wifly::GatherLogonInfo()
WiredHome 25:a740eb74a86a 649 {
WiredHome 25:a740eb74a86a 650 Timer timer;
WiredHome 25:a740eb74a86a 651 char logonText[200];
WiredHome 25:a740eb74a86a 652 int i = 0;
WiredHome 25:a740eb74a86a 653 char *p;
WiredHome 25:a740eb74a86a 654
WiredHome 25:a740eb74a86a 655 timer.start();
WiredHome 25:a740eb74a86a 656 if (wiflyVersionString) {
WiredHome 25:a740eb74a86a 657 free(wiflyVersionString);
WiredHome 25:a740eb74a86a 658 wiflyVersionString = NULL;
WiredHome 25:a740eb74a86a 659 }
WiredHome 25:a740eb74a86a 660 logonText[i] = '\0';
WiredHome 25:a740eb74a86a 661 while (timer.read_ms() < 500) {
WiredHome 25:a740eb74a86a 662 while (wifi.readable()) {
WiredHome 25:a740eb74a86a 663 logonText[i++] = wifi.getc();
WiredHome 25:a740eb74a86a 664 }
WiredHome 25:a740eb74a86a 665 }
WiredHome 25:a740eb74a86a 666 logonText[i] = '\0';
WiredHome 25:a740eb74a86a 667 p = strchr(logonText, '\r');
WiredHome 25:a740eb74a86a 668 if (p)
WiredHome 25:a740eb74a86a 669 *p = '\0';
WiredHome 25:a740eb74a86a 670 wiflyVersionString = (char *)malloc(strlen(logonText)+1);
WiredHome 25:a740eb74a86a 671 if (wiflyVersionString)
WiredHome 25:a740eb74a86a 672 strcpy(wiflyVersionString, logonText);
WiredHome 25:a740eb74a86a 673 p = strstr(logonText, "Ver ");
WiredHome 25:a740eb74a86a 674 if (p) {
WiredHome 25:a740eb74a86a 675 p += 4;
WiredHome 25:a740eb74a86a 676 swVersion = atof(p);
WiredHome 25:a740eb74a86a 677 }
WiredHome 25:a740eb74a86a 678 }
WiredHome 25:a740eb74a86a 679
WiredHome 25:a740eb74a86a 680
WiredHome 25:a740eb74a86a 681 float Wifly::getWiflyVersion()
WiredHome 25:a740eb74a86a 682 {
WiredHome 25:a740eb74a86a 683 return swVersion;
WiredHome 25:a740eb74a86a 684 }
WiredHome 25:a740eb74a86a 685
WiredHome 25:a740eb74a86a 686
WiredHome 25:a740eb74a86a 687 char * Wifly::getWiflyVersionString()
WiredHome 25:a740eb74a86a 688 {
WiredHome 25:a740eb74a86a 689 return wiflyVersionString;
WiredHome 25:a740eb74a86a 690 }
WiredHome 25:a740eb74a86a 691