forked from ekstrand/ESP8266wifi
/
ESP8266wifi.cpp
523 lines (444 loc) · 14.8 KB
/
ESP8266wifi.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
//
// esp8266wifi.cpp
//
//
// Created by Jonas Ekstrand on 2015-02-20.
//
//
#include "ESP8266wifi.h"
// Workaround for http://gcc.gnu.org/bugzilla/show_bug.cgi?id=34734
#ifdef PROGMEM
#undef PROGMEM
#define PROGMEM __attribute__((section(".progmem.data")))
#endif
const char OK[] PROGMEM = "OK";
const char FAIL[] PROGMEM = "FAIL";
const char ERROR[] PROGMEM = "ERROR";
const char NO_CHANGE[] PROGMEM = "no change";
const char SEND_OK[] PROGMEM = "SEND OK";
const char LINK_IS_NOT[] PROGMEM = "link is not";
const char PROMPT[] PROGMEM = ">";
const char BUSY[] PROGMEM = "busy";
const char LINKED[] PROGMEM = "Linked";
const char ALREADY[] PROGMEM = "ALREAY";//yes typo in firmware..
const char READY[] PROGMEM = "ready";
const char NO_IP[] PROGMEM = "0.0.0.0";
const char CIPSEND[] PROGMEM = "AT+CIPSEND=";
const char CIPSERVERSTART[] PROGMEM = "AT+CIPSERVER=1,";
const char CIPSERVERSTOP[] PROGMEM = "AT+CIPSERVER=0";
const char CIPSTART[] PROGMEM = "AT+CIPSTART=4,\"";
const char CIPCLOSE[] PROGMEM = "AT+CIPCLOSE=4";
const char TCP[] PROGMEM = "TCP";
const char UDP[] PROGMEM = "UDP";
const char CWJAP[] PROGMEM = "AT+CWJAP=\"";
const char CWMODE_1[] PROGMEM = "AT+CWMODE=1";
const char CWMODE_3[] PROGMEM = "AT+CWMODE=3";
const char CWMODE_CHECK[] PROGMEM = "AT+CWMODE?";
const char CWMODE_OK[] PROGMEM = "+CWMODE:1";
const char CIFSR[] PROGMEM = "AT+CIFSR";
const char CIPMUX_1[] PROGMEM = "AT+CIPMUX=1";
const char ATE0[] PROGMEM = "ATE0";
const char ATE1[] PROGMEM = "ATE1";
const char CWSAP[] PROGMEM = "AT+CWSAP=\"";
const char IPD[] PROGMEM = "+IPD,";
const char COMMA[] PROGMEM = ",";
const char COMMA_1[] PROGMEM = "\",";
const char COMMA_2[] PROGMEM = "\",\"";
const char THREE_COMMA[] PROGMEM = ",3";
const char DOUBLE_QUOTE[] PROGMEM = "\"";
const char EOL[] PROGMEM = "\n";
const char STAIP[] PROGMEM = "STAIP,\"";
const char STAMAC[] PROGMEM = "STAMAC,\"";
ESP8266wifi::ESP8266wifi(Stream &serialIn, Stream &serialOut, byte resetPin) {
_serialIn = &serialIn;
_serialOut = &serialOut;
_resetPin = resetPin;
pinMode(_resetPin, OUTPUT);
digitalWrite(_resetPin, LOW);//Start with radio off
flags.connectToServerUsingTCP = true;
flags.endSendWithNewline = true;
flags.started = false;
flags.localServerConfigured = false;
flags.localApConfigured = false;
flags.apConfigured = false;
flags.serverConfigured = false;
flags.debug = false;
flags.echoOnOff = false;
}
ESP8266wifi::ESP8266wifi(Stream &serialIn, Stream &serialOut, byte resetPin, Stream &dbgSerial) {
_serialIn = &serialIn;
_serialOut = &serialOut;
_resetPin = resetPin;
pinMode(_resetPin, OUTPUT);
digitalWrite(_resetPin, LOW);//Start with radio off
flags.connectToServerUsingTCP = true;
flags.endSendWithNewline = true;
flags.started = false;
flags.localServerConfigured = false;
flags.localApConfigured = false;
flags.apConfigured = false;
flags.serverConfigured = false;
_dbgSerial = &dbgSerial;
flags.debug = true;
flags.echoOnOff = true;
}
void ESP8266wifi::endSendWithNewline(bool endSendWithNewline){
flags.endSendWithNewline = endSendWithNewline;
}
bool ESP8266wifi::begin() {
msgOut[0] = '\0';
msgIn[0] = '\0';
flags.connectedToServer = false;
flags.localServerConfigured = false;
flags.localApConfigured = false;
serverRetries = 0;
//Do a HW reset
bool statusOk = false;
byte i;
for(i =0; i<HW_RESET_RETRIES; i++){
readCommand(10, NO_IP); //Cleanup
digitalWrite(_resetPin, LOW);
delay(500);
digitalWrite(_resetPin, HIGH); // select the radio
// Look for ready string from wifi module
statusOk = readCommand(3000, READY) == 1;
if(statusOk)
break;
}
if (!statusOk)
return false;
//Turn local AP = off
writeCommand(CWMODE_1, EOL);
if (readCommand(1000, OK, NO_CHANGE) == 0)
return false;
// Set echo on/off
if(flags.echoOnOff)//if echo = true
writeCommand(ATE1, EOL);
else
writeCommand(ATE0, EOL);
if (readCommand(1000, OK, NO_CHANGE) == 0)
return false;
// Set mux to enable multiple connections
writeCommand(CIPMUX_1, EOL);
flags.started = readCommand(3000, OK, NO_CHANGE) > 0;
return flags.started;
}
bool ESP8266wifi::isStarted(){
return flags.started;
}
bool ESP8266wifi::restart() {
return begin()
&& (!flags.localApConfigured || startLocalAp())
&& (!flags.localServerConfigured || startLocalServer())
&& (!flags.apConfigured || connectToAP())
&& (!flags.serverConfigured || connectToServer());
}
bool ESP8266wifi::connectToAP(String& ssid, String& password) {
return connectToAP(ssid.c_str(), password.c_str());
}
bool ESP8266wifi::connectToAP(const char* ssid, const char* password){//TODO make timeout config or parameter??
strncpy(_ssid, ssid, sizeof _ssid);
strncpy(_password, password, sizeof _password);
flags.apConfigured = true;
return connectToAP();
}
bool ESP8266wifi::connectToAP(){
writeCommand(CWJAP);
_serialOut -> print(_ssid);
writeCommand(COMMA_2);
_serialOut -> print(_password);
writeCommand(DOUBLE_QUOTE, EOL);
readCommand(15000, OK, FAIL);
return isConnectedToAP();
}
bool ESP8266wifi::isConnectedToAP(){
writeCommand(CIFSR, EOL);
byte code = readCommand(350, NO_IP, ERROR);
readCommand(10, OK); //cleanup
return (code == 0);
}
char* ESP8266wifi::getIP(){
msgIn[0] = '\0';
writeCommand(CIFSR, EOL);
byte code = readCommand(1000, STAIP, ERROR);
if (code == 1) {
// found staip
readBuffer(&msgIn[0], sizeof(msgIn) - 1, '"');
readCommand(10, OK, ERROR);
return &msgIn[0];
}
readCommand(1000, OK, ERROR);
return &msgIn[0];
}
char* ESP8266wifi::getMAC(){
msgIn[0] = '\0';
writeCommand(CIFSR, EOL);
byte code = readCommand(1000, STAMAC, ERROR);
if (code == 1) {
// found stamac
readBuffer(&msgIn[0], sizeof(msgIn) - 1, '"');
readCommand(10, OK, ERROR);
return &msgIn[0];
}
readCommand(1000, OK, ERROR);
return &msgIn[0];
}
void ESP8266wifi::setTransportToUDP(){
flags.connectToServerUsingTCP = false;
}
void ESP8266wifi::setTransportToTCP(){
flags.connectToServerUsingTCP = true;
}
bool ESP8266wifi::connectToServer(String& ip, String& port) {
return connectToServer(ip.c_str(), port.c_str());
}
bool ESP8266wifi::connectToServer(const char* ip, const char* port){//TODO make timeout config or parameter??
strncpy(_ip, ip, sizeof _ip);
strncpy(_port, port, sizeof _port);
flags.serverConfigured = true;
return connectToServer();
}
bool ESP8266wifi::connectToServer(){
writeCommand(CIPSTART);
if (flags.connectToServerUsingTCP)
writeCommand(TCP);
else
writeCommand(UDP);
writeCommand(COMMA_2);
_serialOut -> print(_ip);
writeCommand(COMMA_1);
_serialOut -> println(_port);
flags.connectedToServer = (readCommand(10000, LINKED, ALREADY) > 0);
if(flags.connectedToServer)
serverRetries = 0;
return flags.connectedToServer;
}
void ESP8266wifi::disconnectFromServer(){
flags.connectedToServer = false;
flags.serverConfigured = false;//disable reconnect
writeCommand(CIPCLOSE);
readCommand(2000, OK); //fire and forget in this case..
}
bool ESP8266wifi::isConnectedToServer(){
if(flags.connectedToServer)
serverRetries = 0;
return flags.connectedToServer;
}
bool ESP8266wifi::startLocalAPAndServer(const char* ssid, const char* password, const char* channel, const char* port){
strncpy(_localAPSSID, ssid, sizeof _localAPSSID);
strncpy(_localAPPassword, password, sizeof _localAPPassword);
strncpy(_localAPChannel, channel, sizeof _localAPChannel);
strncpy(_localServerPort, port, sizeof _localServerPort);
flags.localApConfigured = true;
flags.localServerConfigured = true;
return startLocalAp() && startLocalServer();
}
bool ESP8266wifi::startLocalAP(const char* ssid, const char* password, const char* channel){
strncpy(_localAPSSID, ssid, sizeof _localAPSSID);
strncpy(_localAPPassword, password, sizeof _localAPPassword);
strncpy(_localAPChannel, channel, sizeof _localAPChannel);
flags.localApConfigured = true;
return startLocalAp();
}
bool ESP8266wifi::startLocalServer(const char* port) {
strncpy(_localServerPort, port, sizeof _localServerPort);
flags.localServerConfigured = true;
return startLocalServer();
}
bool ESP8266wifi::startLocalServer(){
// Start local server
writeCommand(CIPSERVERSTART);
_serialOut -> println(_localServerPort);
flags.localServerRunning = (readCommand(2000, OK, NO_CHANGE) > 0);
return flags.localServerRunning;
}
bool ESP8266wifi::startLocalAp(){
// Start local ap mode (eg both local ap and ap)
writeCommand(CWMODE_3, EOL);
if (!readCommand(2000, OK, NO_CHANGE))
return false;
// Configure the soft ap
writeCommand(CWSAP);
_serialOut -> print(_localAPSSID);
writeCommand(COMMA_2);
_serialOut -> print(_localAPPassword);
writeCommand(COMMA_1);
_serialOut -> print(_localAPChannel);
writeCommand(THREE_COMMA, EOL);
flags.localApRunning = (readCommand(5000, OK, ERROR) == 1);
return flags.localApRunning;
}
bool ESP8266wifi::stopLocalServer(){
writeCommand(CIPSERVERSTOP, EOL);
boolean stopped = (readCommand(2000, OK, NO_CHANGE) > 0);
flags.localServerRunning = !stopped;
flags.localServerConfigured = false; //to prevent autostart
return stopped;
}
bool ESP8266wifi::stopLocalAP(){
writeCommand(CWMODE_1, EOL);
boolean stopped = (readCommand(2000, OK, NO_CHANGE) > 0);
flags.localApRunning = !stopped;
flags.localApConfigured = false; //to prevent autostart
return stopped;
}
bool ESP8266wifi::stopLocalAPAndServer(){
return stopLocalAP() && stopLocalServer();
}
bool ESP8266wifi::isLocalAPAndServerRunning(){
return flags.localApRunning & flags.localServerRunning;
}
// Performs a connect retry (or hardware reset) if not connected
bool ESP8266wifi::watchdog() {
if (serverRetries >= SERVER_CONNECT_RETRIES_BEFORE_HW_RESET) {
// give up, do a hardware reset
return restart();
}
if (flags.serverConfigured && !flags.connectedToServer) {
serverRetries++;
if (flags.apConfigured && !isConnectedToAP()) {
if (!connectToAP()) {
// wait a bit longer, then check again
delay(2000);
if (!isConnectedToAP()) {
return restart();
}
}
}
return connectToServer();
}
return true;
}
/*
* Send string (if channel is connected of course)
*/
bool ESP8266wifi::send(char channel, String& message, bool sendNow) {
return send(channel, message.c_str(), sendNow);
}
bool ESP8266wifi::send(char channel, const char * message, bool sendNow){
watchdog();
byte avail = sizeof(msgOut) - strlen(msgOut) - 1;
strncat(msgOut, message, avail);
if (!sendNow)
return true;
byte length = strlen(msgOut);
if(flags.endSendWithNewline)
length += 2;
writeCommand(CIPSEND);
_serialOut -> print(channel);
writeCommand(COMMA);
_serialOut -> println(length);
byte prompt = readCommand(1000, PROMPT, LINK_IS_NOT);
if (prompt != 2) {
if(flags.endSendWithNewline)
_serialOut -> println(msgOut);
else
_serialOut -> print(msgOut);
byte sendStatus = readCommand(5000, SEND_OK, BUSY);
if (sendStatus == 1) {
msgOut[0] = '\0';
if(channel == SERVER)
flags.connectedToServer = true;
return true;
}
}
//else
if(channel == SERVER)
flags.connectedToServer = false;
msgOut[0] = '\0';
return false;
}
WifiMessage ESP8266wifi::listenForIncomingMessage(int timeout){
watchdog();
char buf[16] = {'\0'};
msgIn[0] = '\0';
static WifiMessage msg;
msg.hasData = false;
msg.channel = '-';
msg.message = msgIn;
//TODO listen for unlink etc...
byte msgOrRestart = readCommand(timeout, IPD, READY);
//Detected a esp8266 restart
if (msgOrRestart == 2){
restart();
return msg;
}
//Message received..
else if (msgOrRestart == 1) {
char channel = readChar();
if (channel == SERVER)
flags.connectedToServer = true;
readChar(); // removing comma
readBuffer(&buf[0], sizeof(buf) - 1, ':'); // read char count
readChar(); // removing ':' delim
byte length = atoi(buf);
readBuffer(&msgIn[0], min(length, sizeof(msgIn) - 1));
msg.hasData = true;
msg.channel = channel;
msg.message = msgIn;
readCommand(10, OK); // cleanup after rx
}
return msg;
}
// Writes commands (from PROGMEM) to serial output
void ESP8266wifi::writeCommand(const char* text1 = NULL, const char* text2) {
char buf[16] = {'\0'};
strcpy_P(buf, (char *) text1);
_serialOut->print(buf);
if (text2 == EOL) {
_serialOut->println();
} else if (text2 != NULL) {
strcpy_P(buf, (char *) text2);
_serialOut->print(buf);
}
}
// Reads from serial input until a expected string is found (or until timeout)
// NOTE: strings are stored in PROGMEM (auto-copied by this method)
byte ESP8266wifi::readCommand(int timeout, const char* text1, const char* text2) {
// setup buffers on stack & copy data from PROGMEM pointers
char buf1[16] = {'\0'};
char buf2[16] = {'\0'};
if (text1 != NULL)
strcpy_P(buf1, (char *) text1);
if (text2 != NULL)
strcpy_P(buf2, (char *) text2);
byte len1 = strlen(buf1);
byte len2 = strlen(buf2);
byte pos1 = 0;
byte pos2 = 0;
// read chars until first match or timeout
unsigned long stop = millis() + timeout;
do {
while (_serialIn->available()) {
char c = readChar();
pos1 = (c == buf1[pos1]) ? pos1 + 1 : 0;
pos2 = (c == buf2[pos2]) ? pos2 + 1 : 0;
if (len1 > 0 && pos1 == len1)
return 1;
if (len2 > 0 && pos2 == len2)
return 2;
}
delay(10);
} while (millis() < stop);
return 0;
}
// Reads count chars to a buffer, or until delim char is found
byte ESP8266wifi::readBuffer(char* buf, byte count, char delim) {
byte pos = 0;
while (_serialIn->available() && pos < count) {
if (_serialIn->peek() == delim)
break;
buf[pos++] = readChar();
}
buf[pos] = '\0';
return pos;
}
// Reads a single char from serial input (with debug printout if configured)
char ESP8266wifi::readChar() {
char c = _serialIn->read();
if (flags.debug)
_dbgSerial->print(c);
else
delayMicroseconds(50); // don't know why
return c;
}