jollen chen / WiflyInterface

Improve Wifly Interface

Fork of WiflyInterface by Components

Wifly/Wifly.h@1:fb4494783863, 2012-08-24 (annotated)

Committer:
samux
Date:
Fri Aug 24 13:48:36 2012 +0000
Revision:
1:fb4494783863
Child:
3:9aa05e19c62e
Child:
7:3152fcc74390
first commit

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
samux 1:fb4494783863 33 #define DEFAULT_WAIT_RESP_TIMEOUT 500
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
samux 1:fb4494783863 46 class Wifly
samux 1:fb4494783863 47 {
samux 1:fb4494783863 48
samux 1:fb4494783863 49 public:
samux 1:fb4494783863 50 /*
samux 1:fb4494783863 51 * Constructor
samux 1:fb4494783863 52 *
samux 1:fb4494783863 53 * @param tx mbed pin to use for tx line of Serial interface
samux 1:fb4494783863 54 * @param rx mbed pin to use for rx line of Serial interface
samux 1:fb4494783863 55 * @param reset reset pin of the wifi module ()
samux 1:fb4494783863 56 * @param tcp_status connection status pin of the wifi module (GPIO 6)
samux 1:fb4494783863 57 * @param ssid ssid of the network
samux 1:fb4494783863 58 * @param phrase WEP or WPA key
samux 1:fb4494783863 59 * @param sec Security type (NONE, WEP_128 or WPA)
samux 1:fb4494783863 60 */
samux 1:fb4494783863 61 Wifly( PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec);
samux 1:fb4494783863 62
samux 1:fb4494783863 63 /*
samux 1:fb4494783863 64 * Connect the wifi module to the ssid contained in the constructor.
samux 1:fb4494783863 65 *
samux 1:fb4494783863 66 * @return true if connected, false otherwise
samux 1:fb4494783863 67 */
samux 1:fb4494783863 68 bool join();
samux 1:fb4494783863 69
samux 1:fb4494783863 70 /*
samux 1:fb4494783863 71 * Disconnect the wifly module from the access point
samux 1:fb4494783863 72 *
samux 1:fb4494783863 73 * @ returns true if successful
samux 1:fb4494783863 74 */
samux 1:fb4494783863 75 bool disconnect();
samux 1:fb4494783863 76
samux 1:fb4494783863 77 /*
samux 1:fb4494783863 78 * Open a tcp connection with the specified host on the specified port
samux 1:fb4494783863 79 *
samux 1:fb4494783863 80 * @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 81 * @param port port
samux 1:fb4494783863 82 * @ returns true if successful
samux 1:fb4494783863 83 */
samux 1:fb4494783863 84 bool connect(const char * host, int port);
samux 1:fb4494783863 85
samux 1:fb4494783863 86
samux 1:fb4494783863 87 /*
samux 1:fb4494783863 88 * Set the protocol (UDP or TCP)
samux 1:fb4494783863 89 *
samux 1:fb4494783863 90 * @param p protocol
samux 1:fb4494783863 91 * @ returns true if successful
samux 1:fb4494783863 92 */
samux 1:fb4494783863 93 bool setProtocol(Protocol p);
samux 1:fb4494783863 94
samux 1:fb4494783863 95 /*
samux 1:fb4494783863 96 * Reset the wifi module
samux 1:fb4494783863 97 */
samux 1:fb4494783863 98 void reset();
samux 1:fb4494783863 99
samux 1:fb4494783863 100 /*
samux 1:fb4494783863 101 * Check if characters are available
samux 1:fb4494783863 102 *
samux 1:fb4494783863 103 * @return number of available characters
samux 1:fb4494783863 104 */
samux 1:fb4494783863 105 int readable();
samux 1:fb4494783863 106
samux 1:fb4494783863 107 /*
samux 1:fb4494783863 108 * Check if characters are available
samux 1:fb4494783863 109 *
samux 1:fb4494783863 110 * @return number of available characters
samux 1:fb4494783863 111 */
samux 1:fb4494783863 112 int writeable();
samux 1:fb4494783863 113
samux 1:fb4494783863 114 /*
samux 1:fb4494783863 115 * Check if a tcp link is active
samux 1:fb4494783863 116 *
samux 1:fb4494783863 117 * @returns true if successful
samux 1:fb4494783863 118 */
samux 1:fb4494783863 119 bool is_connected();
samux 1:fb4494783863 120
samux 1:fb4494783863 121 /*
samux 1:fb4494783863 122 * Read a character
samux 1:fb4494783863 123 *
samux 1:fb4494783863 124 * @return the character read
samux 1:fb4494783863 125 */
samux 1:fb4494783863 126 char getc();
samux 1:fb4494783863 127
samux 1:fb4494783863 128 /*
samux 1:fb4494783863 129 * Flush the buffer
samux 1:fb4494783863 130 */
samux 1:fb4494783863 131 void flush();
samux 1:fb4494783863 132
samux 1:fb4494783863 133 /*
samux 1:fb4494783863 134 * Write a character
samux 1:fb4494783863 135 *
samux 1:fb4494783863 136 * @param the character which will be written
samux 1:fb4494783863 137 */
samux 1:fb4494783863 138 int putc(char c);
samux 1:fb4494783863 139
samux 1:fb4494783863 140
samux 1:fb4494783863 141 /*
samux 1:fb4494783863 142 * To enter in command mode (we can configure the module)
samux 1:fb4494783863 143 *
samux 1:fb4494783863 144 * @return true if successful, false otherwise
samux 1:fb4494783863 145 */
samux 1:fb4494783863 146 bool cmdMode();
samux 1:fb4494783863 147
samux 1:fb4494783863 148 /*
samux 1:fb4494783863 149 * To exit the command mode
samux 1:fb4494783863 150 *
samux 1:fb4494783863 151 * @return true if successful, false otherwise
samux 1:fb4494783863 152 */
samux 1:fb4494783863 153 bool exit();
samux 1:fb4494783863 154
samux 1:fb4494783863 155 /*
samux 1:fb4494783863 156 * Close a tcp connection
samux 1:fb4494783863 157 *
samux 1:fb4494783863 158 * @ returns true if successful
samux 1:fb4494783863 159 */
samux 1:fb4494783863 160 bool close();
samux 1:fb4494783863 161
samux 1:fb4494783863 162 /*
samux 1:fb4494783863 163 * 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 164 * Useful to send a command to the module and wait a response.
samux 1:fb4494783863 165 *
samux 1:fb4494783863 166 *
samux 1:fb4494783863 167 * @param str string to be sent
samux 1:fb4494783863 168 * @param len string length
samux 1:fb4494783863 169 * @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 170 * @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)
samux 1:fb4494783863 171 *
samux 1:fb4494783863 172 * @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 173 */
samux 1:fb4494783863 174 int send(const char * str, int len, const char * ACK = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 1:fb4494783863 175
samux 1:fb4494783863 176 /*
samux 1:fb4494783863 177 * Send a command to the wify module. Check if the module is in command mode. If not enter in command mode
samux 1:fb4494783863 178 *
samux 1:fb4494783863 179 * @param str string to be sent
samux 1:fb4494783863 180 * @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 181 * @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)
samux 1:fb4494783863 182 *
samux 1:fb4494783863 183 * @returns true if successful
samux 1:fb4494783863 184 */
samux 1:fb4494783863 185 bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 1:fb4494783863 186
samux 1:fb4494783863 187 bool gethostbyname(const char * host, char * ip);
samux 1:fb4494783863 188
samux 1:fb4494783863 189 static Wifly * getInstance() {
samux 1:fb4494783863 190 return inst;
samux 1:fb4494783863 191 };
samux 1:fb4494783863 192
samux 1:fb4494783863 193 protected:
samux 1:fb4494783863 194 Serial wifi;
samux 1:fb4494783863 195 DigitalOut reset_pin;
samux 1:fb4494783863 196 DigitalIn tcp_status;
samux 1:fb4494783863 197 char phrase[30];
samux 1:fb4494783863 198 char ssid[30];
samux 1:fb4494783863 199 const char * ip;
samux 1:fb4494783863 200 const char * netmask;
samux 1:fb4494783863 201 const char * gateway;
samux 1:fb4494783863 202 int channel;
samux 1:fb4494783863 203 CircBuffer<char> buf_wifly;
samux 1:fb4494783863 204
samux 1:fb4494783863 205 static Wifly * inst;
samux 1:fb4494783863 206
samux 1:fb4494783863 207 void attach_rx(bool null);
samux 1:fb4494783863 208 void handler_rx(void);
samux 1:fb4494783863 209
samux 1:fb4494783863 210
samux 1:fb4494783863 211 typedef struct STATE {
samux 1:fb4494783863 212 bool associated;
samux 1:fb4494783863 213 bool tcp;
samux 1:fb4494783863 214 bool dhcp;
samux 1:fb4494783863 215 Security sec;
samux 1:fb4494783863 216 Protocol proto;
samux 1:fb4494783863 217 bool cmd_mode;
samux 1:fb4494783863 218 } State;
samux 1:fb4494783863 219
samux 1:fb4494783863 220 State state;
samux 1:fb4494783863 221 char * getStringSecurity();
samux 1:fb4494783863 222 };
samux 1:fb4494783863 223
samux 1:fb4494783863 224 #endif