gs fan / GSwifi

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/

GSwifi.h@29:1c4419512941, 2013-02-26 (annotated)

Committer:
gsfan
Date:
Tue Feb 26 02:48:31 2013 +0000
Revision:
29:1c4419512941
Parent:
28:fbba4c58d14c
Child:
31:0abdc584823d
add websocket client

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