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:
Sat Jan 04 20:56:56 2014 +0000
Revision:
57:5259cf47106a
Parent:
51:a4831b1cb9a4
Child:
58:f49aab8072ec
Documentation improvement.

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"
WiredHome 51:a4831b1cb9a4 31 #include "RawSerial.h"
samux 1:fb4494783863 32 #include "CBuffer.h"
samux 1:fb4494783863 33
WiredHome 14:473d73cb48ee 34 #define DEFAULT_WAIT_RESP_TIMEOUT 1000
samux 1:fb4494783863 35
WiredHome 30:f500260463b7 36 enum Security { // See Wifly user manual Table 2-13.
WiredHome 30:f500260463b7 37 NONE = 0,
WiredHome 30:f500260463b7 38 WEP_128 = 1,
WiredHome 30:f500260463b7 39 WPA1 = 2,
WiredHome 30:f500260463b7 40 WPA_MIXED = 3,
WiredHome 30:f500260463b7 41 WPA = 3, // maintained for backward compatibility
WiredHome 30:f500260463b7 42 WPA2_PSK = 4,
WiredHome 30:f500260463b7 43 ADHOC = 6,
WiredHome 30:f500260463b7 44 WPE_64 = 8,
WiredHome 30:f500260463b7 45 WEP_64 = 8 // probably what the last one should have been
samux 1:fb4494783863 46 };
samux 1:fb4494783863 47
samux 1:fb4494783863 48 enum Protocol {
samux 1:fb4494783863 49 UDP = (1 << 0),
samux 1:fb4494783863 50 TCP = (1 << 1)
samux 1:fb4494783863 51 };
samux 1:fb4494783863 52
WiredHome 15:121f473dae3f 53 /** the Wifly object
WiredHome 15:121f473dae3f 54 *
WiredHome 15:121f473dae3f 55 * This object controls the Wifly module.
WiredHome 15:121f473dae3f 56 */
samux 1:fb4494783863 57 class Wifly
samux 1:fb4494783863 58 {
samux 1:fb4494783863 59
samux 1:fb4494783863 60 public:
WiredHome 15:121f473dae3f 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
WiredHome 30:f500260463b7 70 * @param sec Security type (NONE, WEP_128, WPA1, WPA | WPA_MIXED, WPA2_PSK, WEP_64 )
samux 1:fb4494783863 71 */
WiredHome 25:a740eb74a86a 72 Wifly(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec);
samux 1:fb4494783863 73
WiredHome 15:121f473dae3f 74 /**
WiredHome 25:a740eb74a86a 75 * Destructor to clean up
WiredHome 25:a740eb74a86a 76 */
WiredHome 25:a740eb74a86a 77 ~Wifly();
WiredHome 25:a740eb74a86a 78
WiredHome 45:21b7bbaad62b 79 /** Optional means to set/reset the security
WiredHome 45:21b7bbaad62b 80 *
WiredHome 45:21b7bbaad62b 81 * If join() has not been called, then you can revise the security parameters
WiredHome 45:21b7bbaad62b 82 * from those in the constructor.
WiredHome 45:21b7bbaad62b 83 *
WiredHome 45:21b7bbaad62b 84 * @param ssid ssid of the network
WiredHome 45:21b7bbaad62b 85 * @param phrase WEP or WPA key
WiredHome 45:21b7bbaad62b 86 * @param sec Security type (NONE, WEP_128, WPA1, WPA | WPA_MIXED, WPA2_PSK, WEP_64 )
WiredHome 45:21b7bbaad62b 87 */
WiredHome 45:21b7bbaad62b 88 void SetSecurity(const char * ssid, const char * phrase, Security sec);
WiredHome 45:21b7bbaad62b 89
WiredHome 25:a740eb74a86a 90 /**
samux 1:fb4494783863 91 * Connect the wifi module to the ssid contained in the constructor.
samux 1:fb4494783863 92 *
samux 1:fb4494783863 93 * @return true if connected, false otherwise
samux 1:fb4494783863 94 */
samux 1:fb4494783863 95 bool join();
samux 1:fb4494783863 96
WiredHome 15:121f473dae3f 97 /**
samux 1:fb4494783863 98 * Disconnect the wifly module from the access point
samux 1:fb4494783863 99 *
WiredHome 51:a4831b1cb9a4 100 * @return true if successful
samux 1:fb4494783863 101 */
samux 1:fb4494783863 102 bool disconnect();
samux 1:fb4494783863 103
WiredHome 15:121f473dae3f 104 /**
samux 1:fb4494783863 105 * Open a tcp connection with the specified host on the specified port
samux 1:fb4494783863 106 *
samux 1:fb4494783863 107 * @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 108 * @param port port
WiredHome 51:a4831b1cb9a4 109 * @return true if successful
samux 1:fb4494783863 110 */
samux 1:fb4494783863 111 bool connect(const char * host, int port);
samux 1:fb4494783863 112
samux 1:fb4494783863 113
WiredHome 15:121f473dae3f 114 /**
samux 1:fb4494783863 115 * Set the protocol (UDP or TCP)
samux 1:fb4494783863 116 *
samux 1:fb4494783863 117 * @param p protocol
WiredHome 51:a4831b1cb9a4 118 * @return true if successful
samux 1:fb4494783863 119 */
samux 1:fb4494783863 120 bool setProtocol(Protocol p);
samux 1:fb4494783863 121
WiredHome 15:121f473dae3f 122 /**
samux 1:fb4494783863 123 * Reset the wifi module
samux 1:fb4494783863 124 */
samux 1:fb4494783863 125 void reset();
samux 3:9aa05e19c62e 126
WiredHome 15:121f473dae3f 127 /**
samux 3:9aa05e19c62e 128 * Reboot the wifi module
WiredHome 51:a4831b1cb9a4 129 *
WiredHome 51:a4831b1cb9a4 130 * @return true if it could send the command, false otherwise
samux 3:9aa05e19c62e 131 */
samux 3:9aa05e19c62e 132 bool reboot();
samux 1:fb4494783863 133
WiredHome 15:121f473dae3f 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 readable();
samux 1:fb4494783863 140
WiredHome 15:121f473dae3f 141 /**
samux 1:fb4494783863 142 * Check if characters are available
samux 1:fb4494783863 143 *
samux 1:fb4494783863 144 * @return number of available characters
samux 1:fb4494783863 145 */
samux 1:fb4494783863 146 int writeable();
samux 1:fb4494783863 147
WiredHome 15:121f473dae3f 148 /**
samux 1:fb4494783863 149 * Check if a tcp link is active
samux 1:fb4494783863 150 *
WiredHome 51:a4831b1cb9a4 151 * @return true if successful
samux 1:fb4494783863 152 */
samux 1:fb4494783863 153 bool is_connected();
samux 1:fb4494783863 154
WiredHome 15:121f473dae3f 155 /**
samux 1:fb4494783863 156 * Read a character
samux 1:fb4494783863 157 *
samux 1:fb4494783863 158 * @return the character read
samux 1:fb4494783863 159 */
samux 1:fb4494783863 160 char getc();
samux 1:fb4494783863 161
WiredHome 15:121f473dae3f 162 /**
samux 1:fb4494783863 163 * Flush the buffer
samux 1:fb4494783863 164 */
samux 1:fb4494783863 165 void flush();
samux 1:fb4494783863 166
WiredHome 15:121f473dae3f 167 /**
samux 1:fb4494783863 168 * Write a character
samux 1:fb4494783863 169 *
samux 1:fb4494783863 170 * @param the character which will be written
WiredHome 51:a4831b1cb9a4 171 * @return the character written
samux 1:fb4494783863 172 */
samux 1:fb4494783863 173 int putc(char c);
samux 1:fb4494783863 174
samux 1:fb4494783863 175
WiredHome 15:121f473dae3f 176 /**
samux 1:fb4494783863 177 * To enter in command mode (we can configure the module)
samux 1:fb4494783863 178 *
samux 1:fb4494783863 179 * @return true if successful, false otherwise
samux 1:fb4494783863 180 */
samux 1:fb4494783863 181 bool cmdMode();
samux 1:fb4494783863 182
WiredHome 15:121f473dae3f 183 /**
samux 1:fb4494783863 184 * To exit the command mode
samux 1:fb4494783863 185 *
samux 1:fb4494783863 186 * @return true if successful, false otherwise
samux 1:fb4494783863 187 */
samux 1:fb4494783863 188 bool exit();
samux 1:fb4494783863 189
WiredHome 15:121f473dae3f 190 /**
WiredHome 34:52e4eec8b790 191 * Close a tcp connection, and exit command mode.
samux 1:fb4494783863 192 *
WiredHome 51:a4831b1cb9a4 193 * @return true if successful
samux 1:fb4494783863 194 */
samux 1:fb4494783863 195 bool close();
samux 1:fb4494783863 196
WiredHome 15:121f473dae3f 197 /**
samux 1:fb4494783863 198 * 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 199 * Useful to send a command to the module and wait a response.
samux 1:fb4494783863 200 *
samux 1:fb4494783863 201 *
samux 1:fb4494783863 202 * @param str string to be sent
samux 1:fb4494783863 203 * @param len string length
samux 1:fb4494783863 204 * @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 205 * @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 206 * @param timeout is the time in msec to wait for the acknowledge
samux 1:fb4494783863 207 *
samux 1:fb4494783863 208 * @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 209 */
samux 1:fb4494783863 210 int send(const char * str, int len, const char * ACK = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 1:fb4494783863 211
WiredHome 15:121f473dae3f 212 /**
WiredHome 57:5259cf47106a 213 * Send a command to the wify module.
WiredHome 57:5259cf47106a 214 *
WiredHome 57:5259cf47106a 215 * This will send a command to the module. If the module is not in command mode, this will enter in command mode.
WiredHome 57:5259cf47106a 216 * It will not exit command mode automatically (@see exit), however some commands listed in the WiFly User manual,
WiredHome 57:5259cf47106a 217 * in different versions of the firmware, will exit command mode.
samux 1:fb4494783863 218 *
samux 1:fb4494783863 219 * @param str string to be sent
samux 1:fb4494783863 220 * @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 221 * @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 222 * @param timeout is the time in msec to wait for the acknowledge
samux 1:fb4494783863 223 *
WiredHome 51:a4831b1cb9a4 224 * @return true if successful
samux 1:fb4494783863 225 */
samux 1:fb4494783863 226 bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 4:0bcec6272784 227
WiredHome 15:121f473dae3f 228 /**
samux 4:0bcec6272784 229 * Return true if the module is using dhcp
samux 4:0bcec6272784 230 *
WiredHome 51:a4831b1cb9a4 231 * @return true if the module is using dhcp
samux 4:0bcec6272784 232 */
samux 4:0bcec6272784 233 bool isDHCP() {
samux 4:0bcec6272784 234 return state.dhcp;
samux 4:0bcec6272784 235 }
samux 1:fb4494783863 236
WiredHome 15:121f473dae3f 237 /**
WiredHome 15:121f473dae3f 238 * gets the host ip address
WiredHome 15:121f473dae3f 239 *
WiredHome 15:121f473dae3f 240 * @param host is a pointer to the host string to look up
WiredHome 15:121f473dae3f 241 * @param ip contains the host IP in a string after the lookup.
WiredHome 15:121f473dae3f 242 * @param sizeof_ip is the size of the buffer pointed to by ip
WiredHome 51:a4831b1cb9a4 243 * @return true if successful
WiredHome 15:121f473dae3f 244 */
samux 1:fb4494783863 245 bool gethostbyname(const char * host, char * ip);
samux 1:fb4494783863 246
WiredHome 20:906b0f951bc3 247 /**
WiredHome 20:906b0f951bc3 248 * Set the baud rate between the ARM and the WiFly.
WiredHome 20:906b0f951bc3 249 *
WiredHome 20:906b0f951bc3 250 * This will set the WiFly module baud rate first and then
WiredHome 20:906b0f951bc3 251 * set the ARM interface to match it. If it cannot get the proper
WiredHome 20:906b0f951bc3 252 * acknowledge response, it will go on a hunt through the range
WiredHome 20:906b0f951bc3 253 * of standard baud rates.
WiredHome 20:906b0f951bc3 254 *
WiredHome 20:906b0f951bc3 255 * @note Baud rate must be one of 2400, 4800, 9600, 19200, 38400, 57600,
WiredHome 20:906b0f951bc3 256 * 115200, 230400, 460800, or 921600. (See Wifly manual 2.3.64)
WiredHome 20:906b0f951bc3 257 * @note Baud rate of 230400 has been seen to be marginal w/o flow control.
WiredHome 20:906b0f951bc3 258 * @note Setting a baud rate to a 460800 or above may be unrecoverable
WiredHome 20:906b0f951bc3 259 * without resetting the Wifly module.
WiredHome 20:906b0f951bc3 260 *
WiredHome 20:906b0f951bc3 261 * @param baudrate is the desired baudrate.
WiredHome 20:906b0f951bc3 262 *
WiredHome 51:a4831b1cb9a4 263 * @return true if it succeeded, which means that communications can continue,
WiredHome 51:a4831b1cb9a4 264 * @return false if it failed to establish a communication link.
WiredHome 20:906b0f951bc3 265 */
WiredHome 20:906b0f951bc3 266 bool baud(int baudrate);
WiredHome 20:906b0f951bc3 267
WiredHome 25:a740eb74a86a 268
WiredHome 25:a740eb74a86a 269 /**
WiredHome 25:a740eb74a86a 270 * Sets the connection state.
WiredHome 25:a740eb74a86a 271 *
WiredHome 25:a740eb74a86a 272 * Typically used by external apps that detect an incoming connection.
WiredHome 25:a740eb74a86a 273 *
WiredHome 25:a740eb74a86a 274 * @param state sets the connection state to true or false
WiredHome 25:a740eb74a86a 275 */
WiredHome 25:a740eb74a86a 276 void setConnectionState(bool state);
WiredHome 25:a740eb74a86a 277
WiredHome 26:78a1a09afdc9 278
WiredHome 25:a740eb74a86a 279 /**
WiredHome 25:a740eb74a86a 280 * Get the version information from the Wifly module.
WiredHome 25:a740eb74a86a 281 *
WiredHome 51:a4831b1cb9a4 282 * @return the version information as a string, or NULL
WiredHome 25:a740eb74a86a 283 */
WiredHome 25:a740eb74a86a 284 char * getWiflyVersionString();
WiredHome 25:a740eb74a86a 285
WiredHome 26:78a1a09afdc9 286
WiredHome 25:a740eb74a86a 287 /**
WiredHome 25:a740eb74a86a 288 * Get the software version from the Wifly module.
WiredHome 25:a740eb74a86a 289 *
WiredHome 25:a740eb74a86a 290 * This extracts the basic version number (e.g. 2.38, 4.00)
WiredHome 25:a740eb74a86a 291 * as a float.
WiredHome 25:a740eb74a86a 292 *
WiredHome 51:a4831b1cb9a4 293 * @return the software version number as a float.
WiredHome 25:a740eb74a86a 294 */
WiredHome 25:a740eb74a86a 295 float getWiflyVersion();
WiredHome 25:a740eb74a86a 296
WiredHome 26:78a1a09afdc9 297
WiredHome 26:78a1a09afdc9 298 /**
WiredHome 26:78a1a09afdc9 299 * determine if the module is in command mode
WiredHome 26:78a1a09afdc9 300 *
WiredHome 26:78a1a09afdc9 301 * @return true if in command mode, false otherwise
WiredHome 26:78a1a09afdc9 302 */
WiredHome 26:78a1a09afdc9 303 bool isCmdMode() {
WiredHome 26:78a1a09afdc9 304 return state.cmd_mode;
WiredHome 26:78a1a09afdc9 305 }
WiredHome 26:78a1a09afdc9 306
WiredHome 26:78a1a09afdc9 307
samux 1:fb4494783863 308 static Wifly * getInstance() {
samux 1:fb4494783863 309 return inst;
samux 1:fb4494783863 310 };
samux 1:fb4494783863 311
samux 1:fb4494783863 312 protected:
WiredHome 49:81d6f0e1af23 313 #ifdef MODSERIAL_H
WiredHome 49:81d6f0e1af23 314 MODSERIAL wifi;
WiredHome 49:81d6f0e1af23 315 #else
WiredHome 51:a4831b1cb9a4 316 RawSerial wifi;
WiredHome 49:81d6f0e1af23 317 #endif
samux 1:fb4494783863 318 DigitalOut reset_pin;
samux 1:fb4494783863 319 DigitalIn tcp_status;
WiredHome 20:906b0f951bc3 320 int baudrate;
WiredHome 24:5012a535b1d5 321 char * phrase;
WiredHome 24:5012a535b1d5 322 char * ssid;
WiredHome 25:a740eb74a86a 323 char * wiflyVersionString;
WiredHome 25:a740eb74a86a 324 float swVersion;
samux 1:fb4494783863 325 const char * ip;
samux 1:fb4494783863 326 const char * netmask;
samux 1:fb4494783863 327 const char * gateway;
samux 1:fb4494783863 328 CircBuffer<char> buf_wifly;
samux 1:fb4494783863 329
samux 1:fb4494783863 330 static Wifly * inst;
samux 1:fb4494783863 331
samux 1:fb4494783863 332 void attach_rx(bool null);
samux 1:fb4494783863 333 void handler_rx(void);
WiredHome 29:49876a8c445b 334 void flushIn(int timeout_ms = -1);
samux 1:fb4494783863 335
samux 1:fb4494783863 336 typedef struct STATE {
samux 1:fb4494783863 337 bool associated;
samux 1:fb4494783863 338 bool tcp;
samux 1:fb4494783863 339 bool dhcp;
samux 1:fb4494783863 340 Security sec;
samux 1:fb4494783863 341 Protocol proto;
samux 1:fb4494783863 342 bool cmd_mode;
samux 1:fb4494783863 343 } State;
samux 1:fb4494783863 344
samux 1:fb4494783863 345 State state;
samux 1:fb4494783863 346 char * getStringSecurity();
WiredHome 20:906b0f951bc3 347
WiredHome 34:52e4eec8b790 348 void setCmdMode(bool newState);
WiredHome 34:52e4eec8b790 349
WiredHome 20:906b0f951bc3 350 /**
WiredHome 21:97294686b4a1 351 * Estimates the time needed for the Wifly module to respond
WiredHome 21:97294686b4a1 352 * to some of the simple commands.
WiredHome 20:906b0f951bc3 353 *
WiredHome 20:906b0f951bc3 354 * This should only be used for simple commands, where the module should
WiredHome 20:906b0f951bc3 355 * be able to respond almost immediately.
WiredHome 20:906b0f951bc3 356 *
WiredHome 20:906b0f951bc3 357 * @param stringLen of the command to be sent, in characters.
WiredHome 20:906b0f951bc3 358 *
WiredHome 51:a4831b1cb9a4 359 * @return integer number of milliseconds (always rounded up a little)
WiredHome 20:906b0f951bc3 360 */
WiredHome 20:906b0f951bc3 361 int timeToRespond(int stringLen);
WiredHome 20:906b0f951bc3 362
WiredHome 24:5012a535b1d5 363 /**
WiredHome 24:5012a535b1d5 364 * Allocate space for the parameter (ssid or passphrase)
WiredHome 24:5012a535b1d5 365 * and then fix it (change ' ' to '$').
WiredHome 24:5012a535b1d5 366 *
WiredHome 24:5012a535b1d5 367 * @param dst is a reference to the private member pointer.
WiredHome 24:5012a535b1d5 368 * @src is a pointer to a passed in string.
WiredHome 24:5012a535b1d5 369 */
WiredHome 24:5012a535b1d5 370 void FixPhrase(char ** dst, const char * src);
WiredHome 24:5012a535b1d5 371
WiredHome 25:a740eb74a86a 372 /**
WiredHome 25:a740eb74a86a 373 * Gather the Wifly module version information for later queries
WiredHome 25:a740eb74a86a 374 */
WiredHome 25:a740eb74a86a 375 void GatherLogonInfo();
WiredHome 25:a740eb74a86a 376
samux 1:fb4494783863 377 };
samux 1:fb4494783863 378
samux 1:fb4494783863 379 #endif