Damien Frost / WiflyInterface

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   IoT_Ex BatteryModelTester BatteryModelTester

Fork of WiflyInterface by Components

Wifly/Wifly.h@26:eaaedb036df1, 2016-04-01 (annotated)

Committer:
defrost
Date:
Fri Apr 01 00:55:36 2016 +0000
Revision:
26:eaaedb036df1
Parent:
15:eaa1ec0e26bf
Child:
30:2c704a72d88a
- Added setBaud() function to TCPSocket Connection

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
defrost 12:1aaea7f302e6 27
defrost 12:1aaea7f302e6 28
samux 1:fb4494783863 29 #ifndef WIFLY_H
samux 1:fb4494783863 30 #define WIFLY_H
samux 1:fb4494783863 31
samux 1:fb4494783863 32 #include "mbed.h"
samux 1:fb4494783863 33 #include "CBuffer.h"
samux 1:fb4494783863 34
samux 1:fb4494783863 35 #define DEFAULT_WAIT_RESP_TIMEOUT 500
samux 1:fb4494783863 36
defrost 12:1aaea7f302e6 37 extern Serial pc;
defrost 12:1aaea7f302e6 38
samux 1:fb4494783863 39 enum Security {
samux 1:fb4494783863 40 NONE = 0,
samux 1:fb4494783863 41 WEP_128 = 1,
lz307 7:3152fcc74390 42 WPA = 3,
lz307 7:3152fcc74390 43 WPA2 = 4,
samux 1:fb4494783863 44 };
samux 1:fb4494783863 45
samux 1:fb4494783863 46 enum Protocol {
samux 1:fb4494783863 47 UDP = (1 << 0),
samux 1:fb4494783863 48 TCP = (1 << 1)
samux 1:fb4494783863 49 };
samux 1:fb4494783863 50
screamer 5:81e264dbbf03 51 /**
screamer 5:81e264dbbf03 52 * The Wifly class
screamer 5:81e264dbbf03 53 */
samux 1:fb4494783863 54 class Wifly
samux 1:fb4494783863 55 {
samux 1:fb4494783863 56
samux 1:fb4494783863 57 public:
screamer 5:81e264dbbf03 58 /**
samux 1:fb4494783863 59 * Constructor
samux 1:fb4494783863 60 *
samux 1:fb4494783863 61 * @param tx mbed pin to use for tx line of Serial interface
samux 1:fb4494783863 62 * @param rx mbed pin to use for rx line of Serial interface
samux 1:fb4494783863 63 * @param reset reset pin of the wifi module ()
samux 1:fb4494783863 64 * @param tcp_status connection status pin of the wifi module (GPIO 6)
samux 1:fb4494783863 65 * @param ssid ssid of the network
screamer 9:f2439377c172 66 * @param phrase WEP, WPA or WPA2 key
screamer 9:f2439377c172 67 * @param sec Security type (NONE, WEP_128 or WPA, WPA2)
samux 1:fb4494783863 68 */
samux 1:fb4494783863 69 Wifly( PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec);
samux 1:fb4494783863 70
screamer 5:81e264dbbf03 71 /**
samux 1:fb4494783863 72 * Connect the wifi module to the ssid contained in the constructor.
samux 1:fb4494783863 73 *
samux 1:fb4494783863 74 * @return true if connected, false otherwise
samux 1:fb4494783863 75 */
samux 1:fb4494783863 76 bool join();
defrost 26:eaaedb036df1 77
defrost 26:eaaedb036df1 78 /** Sets the baudrate of the serial port used to communicate with the ethernet/wifi adapter
defrost 26:eaaedb036df1 79 * @param baudrate The baudrate that the connection should be set to. Valid values are: 2400, 4800, 9600, 19200, 38400, 115200, 230400, 460800, 921600 do NOT go above 230400
defrost 26:eaaedb036df1 80 */
defrost 15:eaa1ec0e26bf 81 void setBaud(int baudrate);
defrost 15:eaa1ec0e26bf 82
screamer 5:81e264dbbf03 83 /**
samux 1:fb4494783863 84 * Disconnect the wifly module from the access point
samux 1:fb4494783863 85 *
screamer 6:5176e0864078 86 * @return true if successful
samux 1:fb4494783863 87 */
samux 1:fb4494783863 88 bool disconnect();
samux 1:fb4494783863 89
screamer 5:81e264dbbf03 90 /**
samux 1:fb4494783863 91 * Open a tcp connection with the specified host on the specified port
samux 1:fb4494783863 92 *
samux 1:fb4494783863 93 * @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 94 * @param port port
screamer 6:5176e0864078 95 * @return true if successful
samux 1:fb4494783863 96 */
samux 1:fb4494783863 97 bool connect(const char * host, int port);
samux 1:fb4494783863 98
samux 1:fb4494783863 99
screamer 5:81e264dbbf03 100 /**
samux 1:fb4494783863 101 * Set the protocol (UDP or TCP)
samux 1:fb4494783863 102 *
samux 1:fb4494783863 103 * @param p protocol
screamer 6:5176e0864078 104 * @return true if successful
samux 1:fb4494783863 105 */
samux 1:fb4494783863 106 bool setProtocol(Protocol p);
samux 1:fb4494783863 107
screamer 5:81e264dbbf03 108 /**
samux 1:fb4494783863 109 * Reset the wifi module
samux 1:fb4494783863 110 */
samux 1:fb4494783863 111 void reset();
samux 3:9aa05e19c62e 112
screamer 5:81e264dbbf03 113 /**
samux 3:9aa05e19c62e 114 * Reboot the wifi module
samux 3:9aa05e19c62e 115 */
samux 3:9aa05e19c62e 116 bool reboot();
samux 1:fb4494783863 117
screamer 5:81e264dbbf03 118 /**
samux 1:fb4494783863 119 * Check if characters are available
samux 1:fb4494783863 120 *
samux 1:fb4494783863 121 * @return number of available characters
samux 1:fb4494783863 122 */
samux 1:fb4494783863 123 int readable();
samux 1:fb4494783863 124
screamer 5:81e264dbbf03 125 /**
samux 1:fb4494783863 126 * Check if characters are available
samux 1:fb4494783863 127 *
samux 1:fb4494783863 128 * @return number of available characters
samux 1:fb4494783863 129 */
samux 1:fb4494783863 130 int writeable();
samux 1:fb4494783863 131
screamer 5:81e264dbbf03 132 /**
samux 1:fb4494783863 133 * Check if a tcp link is active
samux 1:fb4494783863 134 *
screamer 6:5176e0864078 135 * @return true if successful
samux 1:fb4494783863 136 */
samux 1:fb4494783863 137 bool is_connected();
samux 1:fb4494783863 138
screamer 5:81e264dbbf03 139 /**
samux 1:fb4494783863 140 * Read a character
samux 1:fb4494783863 141 *
samux 1:fb4494783863 142 * @return the character read
samux 1:fb4494783863 143 */
samux 1:fb4494783863 144 char getc();
samux 1:fb4494783863 145
screamer 5:81e264dbbf03 146 /**
samux 1:fb4494783863 147 * Flush the buffer
samux 1:fb4494783863 148 */
samux 1:fb4494783863 149 void flush();
samux 1:fb4494783863 150
screamer 5:81e264dbbf03 151 /**
samux 1:fb4494783863 152 * Write a character
samux 1:fb4494783863 153 *
samux 1:fb4494783863 154 * @param the character which will be written
samux 1:fb4494783863 155 */
samux 1:fb4494783863 156 int putc(char c);
samux 1:fb4494783863 157
samux 1:fb4494783863 158
screamer 5:81e264dbbf03 159 /**
samux 1:fb4494783863 160 * To enter in command mode (we can configure the module)
samux 1:fb4494783863 161 *
samux 1:fb4494783863 162 * @return true if successful, false otherwise
samux 1:fb4494783863 163 */
samux 1:fb4494783863 164 bool cmdMode();
samux 1:fb4494783863 165
screamer 5:81e264dbbf03 166 /**
samux 1:fb4494783863 167 * To exit the command mode
samux 1:fb4494783863 168 *
samux 1:fb4494783863 169 * @return true if successful, false otherwise
samux 1:fb4494783863 170 */
samux 1:fb4494783863 171 bool exit();
samux 1:fb4494783863 172
screamer 5:81e264dbbf03 173 /**
samux 1:fb4494783863 174 * Close a tcp connection
samux 1:fb4494783863 175 *
screamer 6:5176e0864078 176 * @return true if successful
samux 1:fb4494783863 177 */
samux 1:fb4494783863 178 bool close();
samux 1:fb4494783863 179
screamer 5:81e264dbbf03 180 /**
samux 1:fb4494783863 181 * 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 182 * Useful to send a command to the module and wait a response.
samux 1:fb4494783863 183 *
samux 1:fb4494783863 184 *
samux 1:fb4494783863 185 * @param str string to be sent
samux 1:fb4494783863 186 * @param len string length
samux 1:fb4494783863 187 * @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 188 * @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 189 *
samux 1:fb4494783863 190 * @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 191 */
samux 1:fb4494783863 192 int send(const char * str, int len, const char * ACK = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 1:fb4494783863 193
screamer 5:81e264dbbf03 194 /**
samux 1:fb4494783863 195 * Send a command to the wify module. Check if the module is in command mode. If not enter in command mode
samux 1:fb4494783863 196 *
samux 1:fb4494783863 197 * @param str string to be sent
samux 1:fb4494783863 198 * @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 199 * @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 200 *
screamer 6:5176e0864078 201 * @return true if successful
samux 1:fb4494783863 202 */
samux 1:fb4494783863 203 bool sendCommand(const char * cmd, const char * ack = NULL, char * res = NULL, int timeout = DEFAULT_WAIT_RESP_TIMEOUT);
samux 4:0bcec6272784 204
screamer 5:81e264dbbf03 205 /**
samux 4:0bcec6272784 206 * Return true if the module is using dhcp
samux 4:0bcec6272784 207 *
screamer 6:5176e0864078 208 * @return true if the module is using dhcp
samux 4:0bcec6272784 209 */
samux 4:0bcec6272784 210 bool isDHCP() {
samux 4:0bcec6272784 211 return state.dhcp;
samux 4:0bcec6272784 212 }
samux 1:fb4494783863 213
samux 1:fb4494783863 214 bool gethostbyname(const char * host, char * ip);
samux 1:fb4494783863 215
samux 1:fb4494783863 216 static Wifly * getInstance() {
samux 1:fb4494783863 217 return inst;
samux 1:fb4494783863 218 };
samux 1:fb4494783863 219
samux 1:fb4494783863 220 protected:
samux 1:fb4494783863 221 Serial wifi;
samux 1:fb4494783863 222 DigitalOut reset_pin;
samux 1:fb4494783863 223 DigitalIn tcp_status;
samux 1:fb4494783863 224 char phrase[30];
samux 1:fb4494783863 225 char ssid[30];
samux 1:fb4494783863 226 const char * ip;
samux 1:fb4494783863 227 const char * netmask;
samux 1:fb4494783863 228 const char * gateway;
samux 1:fb4494783863 229 int channel;
samux 1:fb4494783863 230 CircBuffer<char> buf_wifly;
samux 1:fb4494783863 231
samux 1:fb4494783863 232 static Wifly * inst;
samux 1:fb4494783863 233
samux 1:fb4494783863 234 void attach_rx(bool null);
samux 1:fb4494783863 235 void handler_rx(void);
samux 1:fb4494783863 236
samux 1:fb4494783863 237
samux 1:fb4494783863 238 typedef struct STATE {
samux 1:fb4494783863 239 bool associated;
samux 1:fb4494783863 240 bool tcp;
samux 1:fb4494783863 241 bool dhcp;
samux 1:fb4494783863 242 Security sec;
samux 1:fb4494783863 243 Protocol proto;
samux 1:fb4494783863 244 bool cmd_mode;
samux 1:fb4494783863 245 } State;
samux 1:fb4494783863 246
samux 1:fb4494783863 247 State state;
samux 1:fb4494783863 248 char * getStringSecurity();
samux 1:fb4494783863 249 };
samux 1:fb4494783863 250
samux 1:fb4494783863 251 #endif