GainSpan Wi-Fi library see: http://mbed.org/users/gsfan/notebook/gainspan_wifi/

Dependents:   GSwifi_httpd GSwifi_websocket GSwifi_tcpclient GSwifi_tcpserver ... more

Fork of GSwifi by gs fan

GainSpan Wi-Fi library

The GS1011 is an ultra low power 802.11b wireless module from GainSpan.

see: http://mbed.org/users/gsfan/notebook/gainspan_wifi/

/media/uploads/gsfan/gs_im_002.jpg /media/uploads/gsfan/gs1011m_2.jpg

ゲインスパン Wi-Fi モジュール ライブラリ

ゲインスパン社の低電力 Wi-Fiモジュール(無線LAN) GS1011 シリーズ用のライブラリです。

解説: http://mbed.org/users/gsfan/notebook/gainspan_wifi/

Committer:
gsfan
Date:
Wed Mar 13 01:22:38 2013 +0000
Revision:
33:b5a5a1e6325f
Parent:
31:0abdc584823d
Child:
35:515ec79792d3
support FRDM KL25Z

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gsfan 25:f6e5622d2930 1 /* Copyright (C) 2013 gsfan, MIT License
gsfan 25:f6e5622d2930 2 *
gsfan 25:f6e5622d2930 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
gsfan 25:f6e5622d2930 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
gsfan 25:f6e5622d2930 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
gsfan 25:f6e5622d2930 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
gsfan 25:f6e5622d2930 7 * furnished to do so, subject to the following conditions:
gsfan 25:f6e5622d2930 8 *
gsfan 25:f6e5622d2930 9 * The above copyright notice and this permission notice shall be included in all copies or
gsfan 25:f6e5622d2930 10 * substantial portions of the Software.
gsfan 25:f6e5622d2930 11 *
gsfan 25:f6e5622d2930 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
gsfan 25:f6e5622d2930 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
gsfan 25:f6e5622d2930 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
gsfan 25:f6e5622d2930 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
gsfan 25:f6e5622d2930 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
gsfan 0:2f6062c6d018 17 */
gsfan 0:2f6062c6d018 18 /** @file
gsfan 0:2f6062c6d018 19 * @brief Gainspan wi-fi module library for mbed
gsfan 0:2f6062c6d018 20 * GS1011MIC, GS1011MIP, GainSpan WiFi Breakout, etc.
gsfan 0:2f6062c6d018 21 */
gsfan 0:2f6062c6d018 22
gsfan 7:b75b7fc144ff 23 #ifndef _GSWIFI_H_
gsfan 7:b75b7fc144ff 24 #define _GSWIFI_H_
gsfan 7:b75b7fc144ff 25
gsfan 26:b347ee3a1087 26 #include "dbg.h"
gsfan 0:2f6062c6d018 27 #include "mbed.h"
gsfan 25:f6e5622d2930 28 #include "CBuffer.h"
gsfan 26:b347ee3a1087 29 #include "GSFunctionPointer.h"
gsfan 0:2f6062c6d018 30 #include "host.h"
gsfan 0:2f6062c6d018 31 #include "ipaddr.h"
gsfan 26:b347ee3a1087 32 #include "GSwifi_conf.h"
gsfan 25:f6e5622d2930 33 #include <ctype.h>
gsfan 0:2f6062c6d018 34
gsfan 25:f6e5622d2930 35
gsfan 23:a783c62c36d0 36 #ifdef GS_UART_DIRECT
gsfan 23:a783c62c36d0 37 #if defined(TARGET_LPC1768) || defined(TARGET_LPC2368)
gsfan 23:a783c62c36d0 38 #define _gs_getc() LPC_UART1->RBR
gsfan 23:a783c62c36d0 39 #define _gs_putc(c) while(!(LPC_UART1->LSR & (1<<5))); LPC_UART1->THR = c
gsfan 23:a783c62c36d0 40 #elif defined(TARGET_LPC11U24)
gsfan 23:a783c62c36d0 41 #define _gs_getc() LPC_USART->RBR
gsfan 23:a783c62c36d0 42 #define _gs_putc(c) while(!(LPC_USART->LSR & (1<<5))); LPC_USART->THR = c
gsfan 33:b5a5a1e6325f 43 #elif defined(TARGET_KL25Z)
gsfan 33:b5a5a1e6325f 44 #error "no support GS_UART_DIRECT"
gsfan 23:a783c62c36d0 45 #endif
gsfan 33:b5a5a1e6325f 46 #else // GS_UART_DIRECT
gsfan 23:a783c62c36d0 47 #define _gs_getc() _gs.getc()
gsfan 23:a783c62c36d0 48 #define _gs_putc(c) _gs.putc(c)
gsfan 23:a783c62c36d0 49 #endif
gsfan 23:a783c62c36d0 50
gsfan 26:b347ee3a1087 51 #ifdef GS_SYSLOG
gsfan 26:b347ee3a1087 52 #define LOG(...) printf("" __VA_ARGS__)
gsfan 26:b347ee3a1087 53 #else
gsfan 26:b347ee3a1087 54 #define LOG(...)
gsfan 26:b347ee3a1087 55 #endif
gsfan 26:b347ee3a1087 56
gsfan 26:b347ee3a1087 57
gsfan 0:2f6062c6d018 58 /**
gsfan 25:f6e5622d2930 59 * GSwifi class
gsfan 25:f6e5622d2930 60 */
gsfan 25:f6e5622d2930 61 class GSwifi {
gsfan 25:f6e5622d2930 62 public:
gsfan 25:f6e5622d2930 63
gsfan 25:f6e5622d2930 64 /**
gsfan 0:2f6062c6d018 65 * Wi-Fi security
gsfan 0:2f6062c6d018 66 */
gsfan 0:2f6062c6d018 67 enum GSSECURITY {
gsfan 0:2f6062c6d018 68 GSSEC_AUTO = 0,
gsfan 0:2f6062c6d018 69 GSSEC_NONE = 0,
gsfan 0:2f6062c6d018 70 GSSEC_OPEN = 1,
gsfan 0:2f6062c6d018 71 GSSEC_WEP = 2,
gsfan 0:2f6062c6d018 72 GSSEC_WPA_PSK = 4,
gsfan 0:2f6062c6d018 73 GSSEC_WPA2_PSK = 8,
gsfan 0:2f6062c6d018 74 GSSEC_WPA_ENT = 16,
gsfan 0:2f6062c6d018 75 GSSEC_WPA2_ENT = 32,
gsfan 0:2f6062c6d018 76 GSSEC_WPS_BUTTON = 64,
gsfan 28:fbba4c58d14c 77 GSSEC_WPS_PIN,
gsfan 0:2f6062c6d018 78 };
gsfan 0:2f6062c6d018 79
gsfan 0:2f6062c6d018 80 /**
gsfan 0:2f6062c6d018 81 * TCP/IP protocol
gsfan 0:2f6062c6d018 82 */
gsfan 0:2f6062c6d018 83 enum GSPROTOCOL {
gsfan 0:2f6062c6d018 84 GSPROT_UDP = 0,
gsfan 0:2f6062c6d018 85 GSPROT_TCP = 1,
gsfan 0:2f6062c6d018 86 GSPROT_HTTPGET,
gsfan 0:2f6062c6d018 87 GSPROT_HTTPPOST,
gsfan 18:4b97804c37d1 88 GSPROT_HTTPD,
gsfan 0:2f6062c6d018 89 };
gsfan 0:2f6062c6d018 90
gsfan 0:2f6062c6d018 91 /**
gsfan 0:2f6062c6d018 92 * Client/Server
gsfan 0:2f6062c6d018 93 */
gsfan 0:2f6062c6d018 94 enum GSTYPE {
gsfan 0:2f6062c6d018 95 GSTYPE_CLIENT = 0,
gsfan 0:2f6062c6d018 96 GSTYPE_SERVER = 1,
gsfan 0:2f6062c6d018 97 };
gsfan 0:2f6062c6d018 98
gsfan 0:2f6062c6d018 99 enum GSRESPONCE {
gsfan 23:a783c62c36d0 100 GSRES_NONE,
gsfan 0:2f6062c6d018 101 GSRES_NORMAL,
gsfan 0:2f6062c6d018 102 GSRES_CONNECT,
gsfan 0:2f6062c6d018 103 GSRES_WPS,
gsfan 0:2f6062c6d018 104 GSRES_MACADDRESS,
gsfan 0:2f6062c6d018 105 GSRES_DHCP,
gsfan 0:2f6062c6d018 106 GSRES_DNSLOOKUP,
gsfan 0:2f6062c6d018 107 GSRES_HTTP,
gsfan 1:b127c6c5241d 108 GSRES_RSSI,
gsfan 5:6def1d0df519 109 GSRES_TIME,
gsfan 0:2f6062c6d018 110 };
gsfan 0:2f6062c6d018 111
gsfan 0:2f6062c6d018 112 enum GSMODE {
gsfan 0:2f6062c6d018 113 GSMODE_COMMAND,
gsfan 0:2f6062c6d018 114 GSMODE_DATA_RX,
gsfan 0:2f6062c6d018 115 GSMODE_DATA_RXUDP,
gsfan 0:2f6062c6d018 116 GSMODE_DATA_RX_BULK,
gsfan 0:2f6062c6d018 117 GSMODE_DATA_RXUDP_BULK,
gsfan 0:2f6062c6d018 118 GSMODE_DATA_RXHTTP,
gsfan 0:2f6062c6d018 119 };
gsfan 0:2f6062c6d018 120
gsfan 0:2f6062c6d018 121 enum GSSTATUS {
gsfan 0:2f6062c6d018 122 GSSTAT_READY,
gsfan 0:2f6062c6d018 123 GSSTAT_STANDBY,
gsfan 0:2f6062c6d018 124 GSSTAT_WAKEUP,
gsfan 0:2f6062c6d018 125 GSSTAT_DEEPSLEEP,
gsfan 0:2f6062c6d018 126 };
gsfan 0:2f6062c6d018 127
gsfan 0:2f6062c6d018 128 /**
gsfan 0:2f6062c6d018 129 * data receive callback function
gsfan 0:2f6062c6d018 130 */
gsfan 1:b127c6c5241d 131 typedef void (*onGsReceiveFunc)(int cid, int len);
gsfan 0:2f6062c6d018 132
gsfan 0:2f6062c6d018 133 struct GS_Socket {
gsfan 0:2f6062c6d018 134 GSTYPE type;
gsfan 0:2f6062c6d018 135 GSPROTOCOL protocol;
gsfan 0:2f6062c6d018 136 bool connect;
gsfan 0:2f6062c6d018 137 Host host;
gsfan 25:f6e5622d2930 138 CircBuffer<char> *data;
gsfan 1:b127c6c5241d 139 int lcid;
gsfan 26:b347ee3a1087 140 bool received;
gsfan 26:b347ee3a1087 141 // onGsReceiveFunc onGsReceive;
gsfan 26:b347ee3a1087 142 GSFunctionPointer onGsReceive;
gsfan 26:b347ee3a1087 143 };
gsfan 26:b347ee3a1087 144
gsfan 26:b347ee3a1087 145 #ifdef GS_USE_HTTPD
gsfan 26:b347ee3a1087 146 enum GSHTTPDMODE {
gsfan 26:b347ee3a1087 147 GSHTTPDMODE_REQUEST,
gsfan 26:b347ee3a1087 148 GSHTTPDMODE_HEAD,
gsfan 26:b347ee3a1087 149 GSHTTPDMODE_SPACE,
gsfan 26:b347ee3a1087 150 GSHTTPDMODE_BODY,
gsfan 26:b347ee3a1087 151 GSHTTPDMODE_ERROR,
gsfan 26:b347ee3a1087 152 GSHTTPDMODE_WEBSOCKET,
gsfan 26:b347ee3a1087 153 GSHTTPDMODE_WEBSOCKET_MASK,
gsfan 26:b347ee3a1087 154 GSHTTPDMODE_WEBSOCKET_BODY,
gsfan 0:2f6062c6d018 155 };
gsfan 0:2f6062c6d018 156
gsfan 26:b347ee3a1087 157 struct GS_httpd {
gsfan 26:b347ee3a1087 158 GSHTTPDMODE mode;
gsfan 26:b347ee3a1087 159 int type;
gsfan 26:b347ee3a1087 160 char *buf; // body
gsfan 26:b347ee3a1087 161 int len; // length of buf
gsfan 26:b347ee3a1087 162 char *uri;
gsfan 26:b347ee3a1087 163 char *file;
gsfan 26:b347ee3a1087 164 char *query;
gsfan 26:b347ee3a1087 165 int length; // content-length
gsfan 26:b347ee3a1087 166 int keepalive;
gsfan 26:b347ee3a1087 167 Host host;
gsfan 26:b347ee3a1087 168 #ifdef GS_USE_WEBSOCKET
gsfan 26:b347ee3a1087 169 int websocket;
gsfan 26:b347ee3a1087 170 char *websocket_key;
gsfan 26:b347ee3a1087 171 int websocket_flg;
gsfan 26:b347ee3a1087 172 char websocket_mask[4];
gsfan 26:b347ee3a1087 173 int websocket_payload;
gsfan 26:b347ee3a1087 174 #endif
gsfan 26:b347ee3a1087 175 };
gsfan 26:b347ee3a1087 176
gsfan 26:b347ee3a1087 177 typedef void (*onHttpdCgiFunc)(int cid, GS_httpd *gshttpd);
gsfan 26:b347ee3a1087 178
gsfan 26:b347ee3a1087 179 struct GS_httpd_handler {
gsfan 26:b347ee3a1087 180 char *uri;
gsfan 26:b347ee3a1087 181 char *dir;
gsfan 26:b347ee3a1087 182 onHttpdCgiFunc onHttpCgi;
gsfan 26:b347ee3a1087 183 };
gsfan 26:b347ee3a1087 184 #endif // GS_USE_HTTPD
gsfan 26:b347ee3a1087 185
gsfan 25:f6e5622d2930 186 // ----- GSwifi.cpp -----
gsfan 0:2f6062c6d018 187 /**
gsfan 0:2f6062c6d018 188 * default constructor
gsfan 0:2f6062c6d018 189 */
gsfan 25:f6e5622d2930 190 GSwifi (PinName p_tx, PinName p_rx, PinName p_reset, PinName p_alarm = NC, int baud = GS_BAUD);
gsfan 0:2f6062c6d018 191 /**
gsfan 0:2f6062c6d018 192 * Default constructor (with hardware fllow controll)
gsfan 0:2f6062c6d018 193 */
gsfan 25:f6e5622d2930 194 GSwifi (PinName p_tx, PinName p_rx, PinName p_cts, PinName p_rts, PinName p_reset, PinName p_alarm = NC, int baud = GS_BAUD);
gsfan 25:f6e5622d2930 195 /**
gsfan 25:f6e5622d2930 196 * reset module
gsfan 25:f6e5622d2930 197 */
gsfan 25:f6e5622d2930 198 void reset ();
gsfan 0:2f6062c6d018 199 /**
gsfan 0:2f6062c6d018 200 * send command
gsfan 0:2f6062c6d018 201 */
gsfan 12:63e714550791 202 int command (const char *cmd, GSRESPONCE res, int timeout = GS_TIMEOUT);
gsfan 0:2f6062c6d018 203 /**
gsfan 26:b347ee3a1087 204 * reset recv responce
gsfan 0:2f6062c6d018 205 */
gsfan 26:b347ee3a1087 206 void resetResponse (GSRESPONCE res);
gsfan 26:b347ee3a1087 207 /**
gsfan 26:b347ee3a1087 208 * wait recv responce
gsfan 26:b347ee3a1087 209 */
gsfan 26:b347ee3a1087 210 int waitResponse (int ms);
gsfan 0:2f6062c6d018 211 /**
gsfan 0:2f6062c6d018 212 * associate infrastructure
gsfan 0:2f6062c6d018 213 * @param sec GSSEC_OPEN, GSSEC_WEP, GSSEC_WPA_PSK, GSSEC_WPA2_PSK, GSSEC_WPS_BUTTON
gsfan 2:c6e0e97901b3 214 * @param ssid SSID
gsfan 2:c6e0e97901b3 215 * @param pass pass phrase
gsfan 2:c6e0e97901b3 216 * @param dhcp 0:static ip, 1:dhcp
gsfan 24:5c350ae2e703 217 * @param reconnect auto re-connect
gsfan 2:c6e0e97901b3 218 * @retval 0 success
gsfan 2:c6e0e97901b3 219 * @retval -1 failure
gsfan 0:2f6062c6d018 220 */
gsfan 24:5c350ae2e703 221 int connect (GSSECURITY sec, const char *ssid, const char *pass, int dhcp = 1, int reconnect = 0);
gsfan 0:2f6062c6d018 222 /**
gsfan 0:2f6062c6d018 223 * adhock
gsfan 0:2f6062c6d018 224 * @param sec GSSEC_OPEN or GSSEC_WEP
gsfan 2:c6e0e97901b3 225 * @param ssid SSID
gsfan 2:c6e0e97901b3 226 * @param pass 10 or 26 hexadecimal digits
gsfan 2:c6e0e97901b3 227 * @param ipaddr my ip address
gsfan 2:c6e0e97901b3 228 * @param netmask subnet mask
gsfan 2:c6e0e97901b3 229 * @retval 0 success
gsfan 2:c6e0e97901b3 230 * @retval -1 failure
gsfan 0:2f6062c6d018 231 */
gsfan 19:cad912f5a6ba 232 int adhock (GSSECURITY sec, const char *ssid, const char *pass, IpAddr ipaddr, IpAddr netmask);
gsfan 0:2f6062c6d018 233 /**
gsfan 0:2f6062c6d018 234 * limited AP
gsfan 0:2f6062c6d018 235 * @param sec GSSEC_OPEN or GSSEC_WEP
gsfan 2:c6e0e97901b3 236 * @param ssid SSID
gsfan 0:2f6062c6d018 237 * @param pass 10 or 26 hexadecimal digits
gsfan 2:c6e0e97901b3 238 * @param ipaddr my ip address (dhcp start address)
gsfan 2:c6e0e97901b3 239 * @param netmask subnet mask
gsfan 2:c6e0e97901b3 240 * @retval 0 success
gsfan 2:c6e0e97901b3 241 * @retval -1 failure
gsfan 0:2f6062c6d018 242 * firmware: s2w-secureweb, s2w-web, s2w-wpsweb
gsfan 0:2f6062c6d018 243 */
gsfan 22:9b077e2823ce 244 int limitedap (GSSECURITY sec, const char *ssid, const char *pass, IpAddr ipaddr, IpAddr netmask, char *dns = NULL);
gsfan 0:2f6062c6d018 245 /**
gsfan 0:2f6062c6d018 246 * unassociate
gsfan 0:2f6062c6d018 247 */
gsfan 0:2f6062c6d018 248 int disconnect ();
gsfan 28:fbba4c58d14c 249 /**
gsfan 28:fbba4c58d14c 250 * re-connect
gsfan 28:fbba4c58d14c 251 */
gsfan 28:fbba4c58d14c 252 int reconnect ();
gsfan 0:2f6062c6d018 253
gsfan 0:2f6062c6d018 254 /**
gsfan 0:2f6062c6d018 255 * use DHCP
gsfan 0:2f6062c6d018 256 */
gsfan 0:2f6062c6d018 257 int setAddress ();
gsfan 0:2f6062c6d018 258 /**
gsfan 0:2f6062c6d018 259 * use static ip address
gsfan 0:2f6062c6d018 260 */
gsfan 0:2f6062c6d018 261 int setAddress (IpAddr ipaddr, IpAddr netmask, IpAddr gateway, IpAddr nameserver);
gsfan 0:2f6062c6d018 262 /**
gsfan 1:b127c6c5241d 263 * get ip address
gsfan 1:b127c6c5241d 264 */
gsfan 1:b127c6c5241d 265 int getAddress (IpAddr &ipaddr, IpAddr &netmask, IpAddr &gateway, IpAddr &nameserver);
gsfan 1:b127c6c5241d 266 /**
gsfan 26:b347ee3a1087 267 * get mac address
gsfan 26:b347ee3a1087 268 */
gsfan 29:1c4419512941 269 int getMacAddress (char *mac);
gsfan 26:b347ee3a1087 270 /**
gsfan 0:2f6062c6d018 271 * resolv hostname
gsfan 2:c6e0e97901b3 272 * @param name hostname
gsfan 2:c6e0e97901b3 273 * @param addr resolved ip address
gsfan 0:2f6062c6d018 274 */
gsfan 0:2f6062c6d018 275 int getHostByName (const char* name, IpAddr &addr);
gsfan 0:2f6062c6d018 276 /**
gsfan 0:2f6062c6d018 277 * resolv hostname
gsfan 2:c6e0e97901b3 278 * @param host.name hostname
gsfan 2:c6e0e97901b3 279 * @param host.ipaddr resolved ip address
gsfan 0:2f6062c6d018 280 */
gsfan 0:2f6062c6d018 281 int getHostByName (Host &host);
gsfan 0:2f6062c6d018 282 /**
gsfan 0:2f6062c6d018 283 * RF power
gsfan 0:2f6062c6d018 284 * @param power 0(high)-7(low)
gsfan 0:2f6062c6d018 285 */
gsfan 0:2f6062c6d018 286 int setRFPower (int power);
gsfan 0:2f6062c6d018 287 /**
gsfan 0:2f6062c6d018 288 * power save mode
gsfan 6:a423f0d197de 289 * @param active rx radio 0:switched off, 1:always on
gsfan 6:a423f0d197de 290 * @param save power save 0:disable, 1:enable
gsfan 0:2f6062c6d018 291 */
gsfan 2:c6e0e97901b3 292 int powerSave (int active, int save);
gsfan 0:2f6062c6d018 293 /**
gsfan 0:2f6062c6d018 294 * standby mode
gsfan 0:2f6062c6d018 295 * @param msec wakeup after
gsfan 0:2f6062c6d018 296 * wakeup after msec or alarm1/2
gsfan 0:2f6062c6d018 297 * core off, save to RTC ram
gsfan 0:2f6062c6d018 298 */
gsfan 0:2f6062c6d018 299 int standby (int msec);
gsfan 0:2f6062c6d018 300 /**
gsfan 0:2f6062c6d018 301 * restore standby
gsfan 0:2f6062c6d018 302 */
gsfan 0:2f6062c6d018 303 int wakeup ();
gsfan 0:2f6062c6d018 304 /**
gsfan 0:2f6062c6d018 305 * deep sleep mode
gsfan 0:2f6062c6d018 306 */
gsfan 0:2f6062c6d018 307 int deepSleep ();
gsfan 0:2f6062c6d018 308 /**
gsfan 0:2f6062c6d018 309 * wifi connected
gsfan 0:2f6062c6d018 310 */
gsfan 0:2f6062c6d018 311 bool isConnected ();
gsfan 0:2f6062c6d018 312 /**
gsfan 0:2f6062c6d018 313 * status
gsfan 2:c6e0e97901b3 314 * @return GSSTATUS
gsfan 0:2f6062c6d018 315 */
gsfan 0:2f6062c6d018 316 GSSTATUS getStatus ();
gsfan 1:b127c6c5241d 317 /**
gsfan 2:c6e0e97901b3 318 * RSSI
gsfan 6:a423f0d197de 319 * @return RSSI (dBm)
gsfan 1:b127c6c5241d 320 */
gsfan 1:b127c6c5241d 321 int getRssi ();
gsfan 5:6def1d0df519 322 /**
gsfan 5:6def1d0df519 323 * set NTP server
gsfan 6:a423f0d197de 324 * @param host SNTP server
gsfan 6:a423f0d197de 325 * @param sec time sync interval, 0:one time
gsfan 5:6def1d0df519 326 */
gsfan 5:6def1d0df519 327 int ntpdate (Host host, int sec = 0);
gsfan 5:6def1d0df519 328 /**
gsfan 6:a423f0d197de 329 * set system time
gsfan 6:a423f0d197de 330 * @param time date time (UTC)
gsfan 5:6def1d0df519 331 */
gsfan 5:6def1d0df519 332 int setTime (time_t time);
gsfan 6:a423f0d197de 333 /**
gsfan 5:6def1d0df519 334 * get RTC time
gsfan 6:a423f0d197de 335 * @return date time (UTC)
gsfan 5:6def1d0df519 336 */
gsfan 5:6def1d0df519 337 time_t getTime ();
gsfan 6:a423f0d197de 338 /**
gsfan 6:a423f0d197de 339 * GPIO output
gsfan 6:a423f0d197de 340 * @param port 10,11,30,31
gsfan 6:a423f0d197de 341 * @param out 0:set(high), 1:reset(low)
gsfan 6:a423f0d197de 342 */
gsfan 6:a423f0d197de 343 int gpioOut (int port, int out);
gsfan 0:2f6062c6d018 344 /**
gsfan 2:c6e0e97901b3 345 * main polling
gsfan 0:2f6062c6d018 346 */
gsfan 0:2f6062c6d018 347 void poll();
gsfan 25:f6e5622d2930 348 /**
gsfan 25:f6e5622d2930 349 * Web server
gsfan 25:f6e5622d2930 350 */
gsfan 25:f6e5622d2930 351 int provisioning (char *user, char *pass);
gsfan 25:f6e5622d2930 352 /**
gsfan 25:f6e5622d2930 353 * change baud rate
gsfan 25:f6e5622d2930 354 */
gsfan 25:f6e5622d2930 355 int setBaud (int baud);
gsfan 25:f6e5622d2930 356 /**
gsfan 25:f6e5622d2930 357 * change radio region
gsfan 25:f6e5622d2930 358 */
gsfan 25:f6e5622d2930 359 int setRegion (int reg = GS_WREGDOMAIN);
gsfan 25:f6e5622d2930 360 /**
gsfan 25:f6e5622d2930 361 * certificate
gsfan 25:f6e5622d2930 362 */
gsfan 25:f6e5622d2930 363 int certAdd (const char *name, const char *cert, int len);
gsfan 0:2f6062c6d018 364
gsfan 25:f6e5622d2930 365 // ----- GSwifi_sock.cpp -----
gsfan 0:2f6062c6d018 366 /**
gsfan 0:2f6062c6d018 367 * tcp/udp client
gsfan 6:a423f0d197de 368 * @return CID, -1:failure
gsfan 0:2f6062c6d018 369 */
gsfan 28:fbba4c58d14c 370 int open (Host &host, GSPROTOCOL pro);
gsfan 28:fbba4c58d14c 371
gsfan 28:fbba4c58d14c 372 int open (Host &host, GSPROTOCOL pro, onGsReceiveFunc ponGsReceive) {
gsfan 28:fbba4c58d14c 373 int cid = open(host, pro);
gsfan 28:fbba4c58d14c 374 if (cid >= 0) _gs_sock[cid].onGsReceive.attach(ponGsReceive);
gsfan 28:fbba4c58d14c 375 return cid;
gsfan 28:fbba4c58d14c 376 }
gsfan 28:fbba4c58d14c 377 template<typename T>
gsfan 28:fbba4c58d14c 378 int open (Host &host, GSPROTOCOL pro, T *object, void (T::*member)(int, int)) {
gsfan 28:fbba4c58d14c 379 int cid = open(host, pro);
gsfan 28:fbba4c58d14c 380 if (cid >= 0) _gs_sock[cid].onGsReceive.attach(object, member);
gsfan 28:fbba4c58d14c 381 return cid;
gsfan 28:fbba4c58d14c 382 }
gsfan 0:2f6062c6d018 383 /**
gsfan 0:2f6062c6d018 384 * tcp/udp server
gsfan 6:a423f0d197de 385 * @return CID, -1:failure
gsfan 0:2f6062c6d018 386 */
gsfan 28:fbba4c58d14c 387 int listen (int port, GSPROTOCOL pro);
gsfan 28:fbba4c58d14c 388
gsfan 28:fbba4c58d14c 389 int listen (int port, GSPROTOCOL pro, onGsReceiveFunc ponGsReceive) {
gsfan 28:fbba4c58d14c 390 int cid = listen(port, pro);
gsfan 28:fbba4c58d14c 391 if (cid >= 0) _gs_sock[cid].onGsReceive.attach(ponGsReceive);
gsfan 28:fbba4c58d14c 392 return cid;
gsfan 28:fbba4c58d14c 393 }
gsfan 26:b347ee3a1087 394 template<typename T>
gsfan 28:fbba4c58d14c 395 int listen (int port, GSPROTOCOL pro, T *object, void (T::*member)(int, int)) {
gsfan 28:fbba4c58d14c 396 int cid = listen(port, pro);
gsfan 28:fbba4c58d14c 397 if (cid >= 0) _gs_sock[cid].onGsReceive.attach(object, member);
gsfan 28:fbba4c58d14c 398 return cid;
gsfan 26:b347ee3a1087 399 }
gsfan 0:2f6062c6d018 400 /**
gsfan 0:2f6062c6d018 401 * close client/server
gsfan 0:2f6062c6d018 402 */
gsfan 0:2f6062c6d018 403 int close (int cid);
gsfan 0:2f6062c6d018 404 /**
gsfan 0:2f6062c6d018 405 * send data tcp(s/c), udp(c)
gsfan 0:2f6062c6d018 406 */
gsfan 19:cad912f5a6ba 407 int send (int cid, const char *buf, int len);
gsfan 0:2f6062c6d018 408 /**
gsfan 0:2f6062c6d018 409 * send data udp(s)
gsfan 0:2f6062c6d018 410 */
gsfan 19:cad912f5a6ba 411 int send (int cid, const char *buf, int len, Host &host);
gsfan 0:2f6062c6d018 412 /**
gsfan 0:2f6062c6d018 413 * recv data tcp(s/c), udp(c)
gsfan 6:a423f0d197de 414 * @return length
gsfan 0:2f6062c6d018 415 */
gsfan 0:2f6062c6d018 416 int recv (int cid, char *buf, int len);
gsfan 0:2f6062c6d018 417 /**
gsfan 0:2f6062c6d018 418 * recv data udp(s)
gsfan 6:a423f0d197de 419 * @return length
gsfan 0:2f6062c6d018 420 */
gsfan 0:2f6062c6d018 421 int recv (int cid, char *buf, int len, Host &host);
gsfan 0:2f6062c6d018 422 /**
gsfan 0:2f6062c6d018 423 * tcp/udp connected
gsfan 0:2f6062c6d018 424 */
gsfan 0:2f6062c6d018 425 bool isConnected (int cid);
gsfan 0:2f6062c6d018 426
gsfan 25:f6e5622d2930 427 // ----- GSwifi_http.cpp -----
gsfan 0:2f6062c6d018 428 /**
gsfan 18:4b97804c37d1 429 * http request (GET method)
gsfan 0:2f6062c6d018 430 */
gsfan 19:cad912f5a6ba 431 int httpGet (Host &host, const char *uri, const char *user, const char *pwd, int ssl = 0, onGsReceiveFunc ponGsReceive = NULL);
gsfan 29:1c4419512941 432 int httpGet (Host &host, const char *uri, int ssl = 0, onGsReceiveFunc ponGsReceive = NULL) {
gsfan 29:1c4419512941 433 return httpGet (host, uri, NULL, NULL, ssl, ponGsReceive);
gsfan 29:1c4419512941 434 }
gsfan 0:2f6062c6d018 435 /**
gsfan 18:4b97804c37d1 436 * http request (POST method)
gsfan 15:5febfc399099 437 */
gsfan 19:cad912f5a6ba 438 int httpPost (Host &host, const char *uri, const char *body, const char *user, const char *pwd, int ssl = 0, onGsReceiveFunc ponGsReceive = NULL);
gsfan 29:1c4419512941 439 int httpPost (Host &host, const char *uri, const char *body, int ssl = 0, onGsReceiveFunc ponGsReceive = NULL) {
gsfan 29:1c4419512941 440 return httpPost (host, uri, body, NULL, NULL, ssl, ponGsReceive);
gsfan 29:1c4419512941 441 }
gsfan 29:1c4419512941 442 /**
gsfan 29:1c4419512941 443 * websocket request (Upgrade method)
gsfan 29:1c4419512941 444 */
gsfan 29:1c4419512941 445 int wsOpen (Host &host, const char *uri, const char *user, const char *pwd, onGsReceiveFunc ponGsReceive = NULL);
gsfan 29:1c4419512941 446 int wsOpen (Host &host, const char *uri, onGsReceiveFunc ponGsReceive = NULL) {
gsfan 29:1c4419512941 447 return wsOpen (host, uri, NULL, NULL, ponGsReceive);
gsfan 29:1c4419512941 448 }
gsfan 29:1c4419512941 449 /**
gsfan 29:1c4419512941 450 * send data websocket
gsfan 29:1c4419512941 451 */
gsfan 29:1c4419512941 452 int wsSend (int cid, const char *buf, int len, const char *mask = NULL);
gsfan 18:4b97804c37d1 453
gsfan 15:5febfc399099 454 /**
gsfan 25:f6e5622d2930 455 * base64 encode
gsfan 25:f6e5622d2930 456 */
gsfan 25:f6e5622d2930 457 int base64encode (char *input, int length, char *output, int len);
gsfan 25:f6e5622d2930 458 /**
gsfan 25:f6e5622d2930 459 * url encode
gsfan 0:2f6062c6d018 460 */
gsfan 25:f6e5622d2930 461 int urlencode (char *str, char *buf, int len);
gsfan 25:f6e5622d2930 462 /**
gsfan 25:f6e5622d2930 463 * url decode
gsfan 25:f6e5622d2930 464 */
gsfan 25:f6e5622d2930 465 int urldecode (char *str, char *buf, int len);
gsfan 0:2f6062c6d018 466
gsfan 20:151b5a4fdd29 467 #ifdef GS_USE_SMTP
gsfan 25:f6e5622d2930 468 // ----- GSwifi_smtp.cpp -----
gsfan 18:4b97804c37d1 469 /**
gsfan 18:4b97804c37d1 470 * send mail (smtp)
gsfan 18:4b97804c37d1 471 * @param host SMTP server
gsfan 18:4b97804c37d1 472 * @param to To address
gsfan 18:4b97804c37d1 473 * @param from From address
gsfan 18:4b97804c37d1 474 * @param subject Subject
gsfan 18:4b97804c37d1 475 * @param mesg Message
gsfan 18:4b97804c37d1 476 * @param user username (SMTP Auth)
gsfan 18:4b97804c37d1 477 * @param pwd password (SMTP Auth)
gsfan 18:4b97804c37d1 478 * @retval 0 success
gsfan 18:4b97804c37d1 479 * @retval -1 failure
gsfan 18:4b97804c37d1 480 */
gsfan 19:cad912f5a6ba 481 int mail (Host &host, const char *to, const char *from, const char *subject, const char *mesg, const char *user = NULL, const char *pwd = NULL);
gsfan 20:151b5a4fdd29 482 #endif
gsfan 18:4b97804c37d1 483
gsfan 20:151b5a4fdd29 484 #ifdef GS_USE_HTTPD
gsfan 25:f6e5622d2930 485 // ----- GSwifi_httpd.cpp -----
gsfan 18:4b97804c37d1 486 /**
gsfan 18:4b97804c37d1 487 * start http server
gsfan 18:4b97804c37d1 488 * @param port
gsfan 18:4b97804c37d1 489 */
gsfan 18:4b97804c37d1 490 int httpd (int port = 80);
gsfan 18:4b97804c37d1 491 /**
gsfan 18:4b97804c37d1 492 * attach uri to dirctory handler
gsfan 18:4b97804c37d1 493 */
gsfan 18:4b97804c37d1 494 void send_httpd_error (int cid, int err);
gsfan 18:4b97804c37d1 495 /**
gsfan 18:4b97804c37d1 496 * attach uri to dirctory handler
gsfan 18:4b97804c37d1 497 */
gsfan 19:cad912f5a6ba 498 int attach_httpd (const char *uri, const char *dir);
gsfan 18:4b97804c37d1 499 /**
gsfan 18:4b97804c37d1 500 * attach uri to cgi handler
gsfan 18:4b97804c37d1 501 */
gsfan 19:cad912f5a6ba 502 int attach_httpd (const char *uri, onHttpdCgiFunc ponHttpCgi);
gsfan 20:151b5a4fdd29 503 #endif
gsfan 18:4b97804c37d1 504
gsfan 22:9b077e2823ce 505 #ifdef DEBUG
gsfan 23:a783c62c36d0 506 void dump ();
gsfan 0:2f6062c6d018 507 void test ();
gsfan 0:2f6062c6d018 508 int getc();
gsfan 0:2f6062c6d018 509 void putc(char c);
gsfan 0:2f6062c6d018 510 int readable();
gsfan 18:4b97804c37d1 511 #endif
gsfan 0:2f6062c6d018 512
gsfan 0:2f6062c6d018 513 protected:
gsfan 26:b347ee3a1087 514 void parseResponse ();
gsfan 26:b347ee3a1087 515 void parseCmdResponse (char *buf);
gsfan 26:b347ee3a1087 516
gsfan 0:2f6062c6d018 517 int x2i (char c);
gsfan 0:2f6062c6d018 518 char i2x (int i);
gsfan 0:2f6062c6d018 519 void isr_recv ();
gsfan 20:151b5a4fdd29 520 int from_hex (int ch);
gsfan 20:151b5a4fdd29 521 int to_hex (int code);
gsfan 0:2f6062c6d018 522
gsfan 26:b347ee3a1087 523 void newSock (int cid, GSTYPE type, GSPROTOCOL pro);
gsfan 26:b347ee3a1087 524
gsfan 26:b347ee3a1087 525 void newSock (int cid, GSTYPE type, GSPROTOCOL pro, onGsReceiveFunc ponGsReceive) {
gsfan 28:fbba4c58d14c 526 newSock(cid, type, pro);
gsfan 26:b347ee3a1087 527 _gs_sock[cid].onGsReceive.attach(ponGsReceive);
gsfan 26:b347ee3a1087 528 }
gsfan 26:b347ee3a1087 529 template<typename T>
gsfan 26:b347ee3a1087 530 void newSock (int cid, GSTYPE type, GSPROTOCOL pro, T *object, void (T::*member)(int, int)) {
gsfan 28:fbba4c58d14c 531 newSock(cid, type, pro);
gsfan 26:b347ee3a1087 532 _gs_sock[cid].onGsReceive.attach(object, member);
gsfan 26:b347ee3a1087 533 }
gsfan 25:f6e5622d2930 534
gsfan 29:1c4419512941 535 int wait_ws (int cid, int code);
gsfan 29:1c4419512941 536
gsfan 20:151b5a4fdd29 537 #ifdef GS_USE_SMTP
gsfan 18:4b97804c37d1 538 int wait_smtp (int cid, int code);
gsfan 20:151b5a4fdd29 539 #endif
gsfan 18:4b97804c37d1 540
gsfan 20:151b5a4fdd29 541 #ifdef GS_USE_HTTPD
gsfan 23:a783c62c36d0 542 int get_handler (char *uri);
gsfan 19:cad912f5a6ba 543 int httpd_request (int cid, GS_httpd *gshttpd, char *dir);
gsfan 19:cad912f5a6ba 544 char *mimetype (char *file);
gsfan 31:0abdc584823d 545 int strnicmp (const char *p1, const char *p2, int n);
gsfan 20:151b5a4fdd29 546 #endif
gsfan 18:4b97804c37d1 547
gsfan 0:2f6062c6d018 548 private:
gsfan 0:2f6062c6d018 549 Serial _gs;
gsfan 0:2f6062c6d018 550 bool _rts;
gsfan 26:b347ee3a1087 551 DigitalInOut _reset;
gsfan 26:b347ee3a1087 552 DigitalInOut *_alarm;
gsfan 0:2f6062c6d018 553 volatile bool _connect;
gsfan 0:2f6062c6d018 554 volatile GSSTATUS _status;
gsfan 26:b347ee3a1087 555 volatile bool _gs_ok, _gs_failure;
gsfan 26:b347ee3a1087 556 volatile int _gs_flg;
gsfan 26:b347ee3a1087 557 volatile GSRESPONCE _gs_res;
gsfan 0:2f6062c6d018 558 GSMODE _gs_mode;
gsfan 26:b347ee3a1087 559 bool _escape;
gsfan 1:b127c6c5241d 560 int _cid, _rssi;
gsfan 0:2f6062c6d018 561 IpAddr _ipaddr, _netmask, _gateway, _nameserver, _resolv;
gsfan 0:2f6062c6d018 562 Host _from, _to;
gsfan 4:a8d38857f3fd 563 char _mac[6];
gsfan 25:f6e5622d2930 564 CircBuffer<char> _buf_cmd;
gsfan 0:2f6062c6d018 565 struct GS_Socket _gs_sock[16];
gsfan 5:6def1d0df519 566 time_t _time;
gsfan 28:fbba4c58d14c 567 GSSECURITY _sec;
gsfan 26:b347ee3a1087 568 char *_ssid, *_pass;
gsfan 24:5c350ae2e703 569 int _reconnect, _reconnect_count;
gsfan 18:4b97804c37d1 570
gsfan 20:151b5a4fdd29 571 #ifdef GS_USE_HTTPD
gsfan 18:4b97804c37d1 572 struct GS_httpd _httpd[16];
gsfan 18:4b97804c37d1 573 struct GS_httpd_handler _handler[10];
gsfan 18:4b97804c37d1 574 int _handler_count;
gsfan 20:151b5a4fdd29 575
gsfan 20:151b5a4fdd29 576 void poll_httpd (int cid, int len);
gsfan 23:a783c62c36d0 577 #ifdef GS_USE_WEBSOCKET
gsfan 23:a783c62c36d0 578 void poll_websocket (int cid, int len);
gsfan 23:a783c62c36d0 579 void send_websocket_accept (int cid);
gsfan 23:a783c62c36d0 580 #endif
gsfan 20:151b5a4fdd29 581 #endif
gsfan 0:2f6062c6d018 582 };
gsfan 7:b75b7fc144ff 583
gsfan 7:b75b7fc144ff 584 #endif