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 Dec 03 02:06:24 2018 +0000
Revision:
78:a03a5dade5b5
Parent:
WiflyInterface.h@77:41f9c7987e0a
Renamed the WiflyInterface header and class name to EthernetInterface to be more readily swapped with the wired version. The TimeInterface then works directly.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WiredHome 78:a03a5dade5b5 1 /* EthernetInterface.h */
mbed_official 0:302ec35139ec 2 /* Copyright (C) 2012 mbed.org, MIT License
mbed_official 0:302ec35139ec 3 *
mbed_official 0:302ec35139ec 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
mbed_official 0:302ec35139ec 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
mbed_official 0:302ec35139ec 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
mbed_official 0:302ec35139ec 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
mbed_official 0:302ec35139ec 8 * furnished to do so, subject to the following conditions:
mbed_official 0:302ec35139ec 9 *
mbed_official 0:302ec35139ec 10 * The above copyright notice and this permission notice shall be included in all copies or
mbed_official 0:302ec35139ec 11 * substantial portions of the Software.
mbed_official 0:302ec35139ec 12 *
mbed_official 0:302ec35139ec 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
mbed_official 0:302ec35139ec 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
mbed_official 0:302ec35139ec 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
mbed_official 0:302ec35139ec 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
mbed_official 0:302ec35139ec 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
WiredHome 68:d9a3920cc407 18 *
WiredHome 68:d9a3920cc407 19 * Changes relative to mbed official version and others as identified
WiredHome 68:d9a3920cc407 20 * in the thread http://mbed.org/forum/team-165-components-community/topic/4844/?page=1#comment-24108
WiredHome 78:a03a5dade5b5 21 * EthernetInterface:
WiredHome 68:d9a3920cc407 22 * @li Improve documentation
WiredHome 68:d9a3920cc407 23 * @li add setSecurity() api
WiredHome 68:d9a3920cc407 24 * @li correct connect() api return value (it was inverted)
WiredHome 68:d9a3920cc407 25 * @li derived from 4:0bcec6272784
mbed_official 0:302ec35139ec 26 */
WiredHome 44:dc8ef27bd311 27
WiredHome 78:a03a5dade5b5 28 #ifndef EthernetInterface_H_
WiredHome 78:a03a5dade5b5 29 #define EthernetInterface_H_
mbed_official 0:302ec35139ec 30
samux 1:fb4494783863 31 #include "Wifly.h"
samux 1:fb4494783863 32
WiredHome 44:dc8ef27bd311 33 /** Interface using Wifly to connect to an IP-based network
WiredHome 44:dc8ef27bd311 34 *
WiredHome 44:dc8ef27bd311 35 */
WiredHome 78:a03a5dade5b5 36 class EthernetInterface: public Wifly
WiredHome 44:dc8ef27bd311 37 {
samux 1:fb4494783863 38 public:
samux 1:fb4494783863 39
samux 1:fb4494783863 40 /**
WiredHome 44:dc8ef27bd311 41 * Construct the WiFlyInterface.
WiredHome 44:dc8ef27bd311 42 *
WiredHome 44:dc8ef27bd311 43 * API Precedence:
WiredHome 44:dc8ef27bd311 44 * @verbatim
WiredHome 78:a03a5dade5b5 45 * EthernetInterface() -->
WiredHome 77:41f9c7987e0a 46 * +------------------+ +---------------------------+
WiredHome 77:41f9c7987e0a 47 * v ^ v ^
WiredHome 77:41f9c7987e0a 48 * -> init() -+----------------->+-> connect() -+-------------------------->+-> disconnect() --|
WiredHome 77:41f9c7987e0a 49 * | ^ +-> getName() --------------+
WiredHome 77:41f9c7987e0a 50 * +-> setName() -----+ +-> getIPAddress() ---------+
WiredHome 77:41f9c7987e0a 51 * | | +-> getMACAddress() --------+
WiredHome 77:41f9c7987e0a 52 * +-> setSecurity() -+ +-> Wifly APIs -------------+
WiredHome 77:41f9c7987e0a 53 * +-> get_connection_speed() -+
WiredHome 44:dc8ef27bd311 54 * @endverbatim
samux 1:fb4494783863 55 *
WiredHome 45:21b7bbaad62b 56 * @note The optional ssid, phrase, and sec parameters may be deferred, or
WiredHome 45:21b7bbaad62b 57 * overridden prior to the connect().
WiredHome 45:21b7bbaad62b 58 *
WiredHome 51:a4831b1cb9a4 59 * @param tx mbed pin to use for tx line of Serial interface
WiredHome 51:a4831b1cb9a4 60 * @param rx mbed pin to use for rx line of Serial interface
WiredHome 51:a4831b1cb9a4 61 * @param reset reset pin of the wifi module ()
WiredHome 51:a4831b1cb9a4 62 * @param tcp_status connection status pin of the wifi module (GPIO 6)
WiredHome 51:a4831b1cb9a4 63 * @param ssid optional parameter which is the ssid of the network
WiredHome 51:a4831b1cb9a4 64 * @param phrase optional parameter which is the WEP or WPA key/phrase
WiredHome 51:a4831b1cb9a4 65 * @param sec optional security type (NONE[default], WEP_128 or WPA)
samux 1:fb4494783863 66 */
WiredHome 78:a03a5dade5b5 67 EthernetInterface(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid = NULL, const char * phrase = NULL, Security sec = NONE);
samux 1:fb4494783863 68
WiredHome 44:dc8ef27bd311 69 /** Initialize the interface with DHCP.
WiredHome 44:dc8ef27bd311 70 * Initialize the interface and configure it to use DHCP (no connection at this point).
WiredHome 51:a4831b1cb9a4 71 * @return 0 on success, a negative number on failure
WiredHome 44:dc8ef27bd311 72 */
WiredHome 44:dc8ef27bd311 73 int init(); //With DHCP
samux 1:fb4494783863 74
WiredHome 44:dc8ef27bd311 75 /** Initialize the interface with a static IP address.
WiredHome 45:21b7bbaad62b 76 *
WiredHome 45:21b7bbaad62b 77 * Initialize the interface and configure it with the following static
WiredHome 45:21b7bbaad62b 78 * configuration (no connection at this point).
WiredHome 45:21b7bbaad62b 79 *
WiredHome 51:a4831b1cb9a4 80 * @param ip the IP address to use
WiredHome 51:a4831b1cb9a4 81 * @param mask the IP address mask
WiredHome 51:a4831b1cb9a4 82 * @param gateway the gateway to use
WiredHome 51:a4831b1cb9a4 83 * @return 0 on success, a negative number on failure
WiredHome 44:dc8ef27bd311 84 */
WiredHome 44:dc8ef27bd311 85 int init(const char* ip, const char* mask, const char* gateway);
samux 1:fb4494783863 86
WiredHome 45:21b7bbaad62b 87 /** Set security parameters for the interface.
WiredHome 45:21b7bbaad62b 88 *
WiredHome 45:21b7bbaad62b 89 * Prior to connect, this interface permits changing the security parameters. This
WiredHome 45:21b7bbaad62b 90 * can be most useful when the Wifly module may be used where there are multiple access
WiredHome 45:21b7bbaad62b 91 * points to be connected to. With this, the interface can be brought online far
WiredHome 45:21b7bbaad62b 92 * enough to scan for available access points.
WiredHome 45:21b7bbaad62b 93 *
WiredHome 51:a4831b1cb9a4 94 * @param ssid optional parameter which is the ssid of the network
WiredHome 51:a4831b1cb9a4 95 * @param phrase optional parameter which is the WEP or WPA key/phrase
WiredHome 51:a4831b1cb9a4 96 * @param sec optional security type (NONE[default], WEP_128 or WPA)
WiredHome 45:21b7bbaad62b 97 */
WiredHome 45:21b7bbaad62b 98 void setSecurity(const char * ssid = NULL, const char * phrase = NULL, Security sec = NONE);
WiredHome 45:21b7bbaad62b 99
WiredHome 44:dc8ef27bd311 100 /** Connect
WiredHome 44:dc8ef27bd311 101 * Bring the interface up, start DHCP if needed.
WiredHome 51:a4831b1cb9a4 102 * @return 0 on success, a negative number on failure
WiredHome 44:dc8ef27bd311 103 */
WiredHome 44:dc8ef27bd311 104 int connect();
WiredHome 44:dc8ef27bd311 105
WiredHome 44:dc8ef27bd311 106 /** Disconnect
WiredHome 44:dc8ef27bd311 107 * Bring the interface down
WiredHome 51:a4831b1cb9a4 108 * @return 0 on success, a negative number on failure
WiredHome 44:dc8ef27bd311 109 */
WiredHome 44:dc8ef27bd311 110 int disconnect();
WiredHome 44:dc8ef27bd311 111
WiredHome 72:9499f5c1e00b 112 /** Get the MAC address of your Ethernet interface.
WiredHome 72:9499f5c1e00b 113 *
WiredHome 72:9499f5c1e00b 114 * @return a pointer to a string containing the MAC address
WiredHome 72:9499f5c1e00b 115 */
WiredHome 72:9499f5c1e00b 116 char * getMACAddress();
WiredHome 72:9499f5c1e00b 117
WiredHome 44:dc8ef27bd311 118 /** Get IP address
WiredHome 44:dc8ef27bd311 119 *
WiredHome 72:9499f5c1e00b 120 * @return a pointer to a string containing the IP address
WiredHome 44:dc8ef27bd311 121 */
WiredHome 72:9499f5c1e00b 122 char * getIPAddress();
WiredHome 72:9499f5c1e00b 123
WiredHome 72:9499f5c1e00b 124 /** setName
WiredHome 72:9499f5c1e00b 125 *
WiredHome 72:9499f5c1e00b 126 * Set the network name for this device. Apply this before
WiredHome 72:9499f5c1e00b 127 * calling 'connect'.
WiredHome 72:9499f5c1e00b 128 *
WiredHome 72:9499f5c1e00b 129 * @example
WiredHome 72:9499f5c1e00b 130 * EthernetInterface eth;
WiredHome 72:9499f5c1e00b 131 * ...
WiredHome 72:9499f5c1e00b 132 * if (0 == eth.init()) {
WiredHome 72:9499f5c1e00b 133 * eth.setName("Sensor 3");
WiredHome 72:9499f5c1e00b 134 * if (0 == eth.connect()) {
WiredHome 72:9499f5c1e00b 135 * ...
WiredHome 72:9499f5c1e00b 136 *
WiredHome 72:9499f5c1e00b 137 * @param myname is the name to assign for this node.
WiredHome 72:9499f5c1e00b 138 * Only the first 32 characters will be used if the
WiredHome 72:9499f5c1e00b 139 * name is longer.
WiredHome 72:9499f5c1e00b 140 * Only '0'-'9', 'A'-'Z', 'a'-'z' are accepted,
WiredHome 72:9499f5c1e00b 141 * any others are converted to '-'.
WiredHome 72:9499f5c1e00b 142 * @return 0 on success, a negative number on failure.
WiredHome 72:9499f5c1e00b 143 */
WiredHome 72:9499f5c1e00b 144 int setName(const char * myname);
WiredHome 72:9499f5c1e00b 145
WiredHome 72:9499f5c1e00b 146 /** getName
WiredHome 72:9499f5c1e00b 147 *
WiredHome 72:9499f5c1e00b 148 * Get the network name for this device.
WiredHome 72:9499f5c1e00b 149 *
WiredHome 72:9499f5c1e00b 150 * @return pointer to the name (or null)
WiredHome 72:9499f5c1e00b 151 */
WiredHome 72:9499f5c1e00b 152 const char * getName(void);
WiredHome 44:dc8ef27bd311 153
WiredHome 73:59d0bbc4f905 154 /** get the speed of the connection.
WiredHome 73:59d0bbc4f905 155 *
WiredHome 73:59d0bbc4f905 156 * @return the connection speed, which can range from 1 to 54 (Mb/s)
WiredHome 73:59d0bbc4f905 157 * @return 0 if the information could not be acquired.
WiredHome 73:59d0bbc4f905 158 */
WiredHome 73:59d0bbc4f905 159 int get_connection_speed(void);
WiredHome 73:59d0bbc4f905 160
samux 1:fb4494783863 161 private:
WiredHome 72:9499f5c1e00b 162 char ip_string[16]; // "129.168.100.123\0"
WiredHome 72:9499f5c1e00b 163 bool ip_set; // true when we have captured the IP address
WiredHome 72:9499f5c1e00b 164 char mac_string[18]; // "11:22:33:44:55:66\0"
WiredHome 72:9499f5c1e00b 165 bool mac_set; // true when we have captured the MAC address
samux 1:fb4494783863 166 };
samux 1:fb4494783863 167
samux 1:fb4494783863 168 #include "TCPSocketConnection.h"
samux 1:fb4494783863 169 #include "TCPSocketServer.h"
samux 1:fb4494783863 170 #include "UDPSocket.h"
samux 1:fb4494783863 171
WiredHome 78:a03a5dade5b5 172 #endif /* EthernetInterface_H_ */