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@35:515ec79792d3, 2013-06-21 (annotated)

Committer:
gsfan
Date:
Fri Jun 21 06:08:37 2013 +0000
Revision:
35:515ec79792d3
Parent:
33:b5a5a1e6325f
Child:
36:a70b11e1560f
fix getMac, reconnect

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