-
Notifications
You must be signed in to change notification settings - Fork 48
/
EnigmaIOTNode.cpp
2691 lines (2260 loc) · 82.3 KB
/
EnigmaIOTNode.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
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* @file EnigmaIOTNode.cpp
* @version 0.9.7
* @date 04/02/2021
* @author German Martin
* @brief Library to build a node for EnigmaIoT system
*/
//#define ESP8266
//#ifdef ESP8266
#include <Arduino.h>
#include "EnigmaIOTNode.h"
#include "timeManager.h"
#include <FS.h>
#include <MD5Builder.h>
#ifdef ESP8266
#include <Updater.h>
#elif defined ESP32
#include <Update.h>
#include "esp_wifi.h"
#endif
#include <StreamString.h>
#include <ArduinoJson.h>
#include <regex>
const char CONFIG_FILE[] = "/config.json";
int localLed = -1;
#ifdef ESP32
TimerHandle_t ledTimer;
#elif defined(ESP8266)
ETSTimer ledTimer;
#endif // ESP32
bool nodeConnectionLedFlashing = false;
#ifdef ESP32
RTC_DATA_ATTR rtcmem_data_t rtcmem_data_storage; ///< @brief Context data to be kept on persistent storage
#endif
void EnigmaIOTNodeClass::resetConfig () {
restartReason = CONFIG_RESET;
sendRestart ();
FILESYSTEM.begin ();
FILESYSTEM.remove (CONFIG_FILE);
FILESYSTEM.end ();
DEBUG_WARN ("Config file %s deleted. Restarting");
clearRTC ();
ESP.restart ();
}
void EnigmaIOTNodeClass::sendRestart () {
const size_t len = 2;
uint8_t buffer[len];
buffer[0] = RESTART_CONFIRM;
buffer[1] = restartReason;
DEBUG_WARN ("Message Len %d\n", len);
DEBUG_WARN ("Trying to send: %s\n", printHexBuffer (buffer, len));
if (!EnigmaIOTNode.sendData (buffer, len, true)) {
DEBUG_WARN ("Error sending restart");
} else {
DEBUG_WARN ("Restart sent");
}
//time_t restartRequested = millis ();
//while (millis () - restartRequested > 200) {
// yield ();
//}
}
uint32_t EnigmaIOTNodeClass::getSleepTime () {
if (!node.getSleepy ()) {
return 0;
} else {
return rtcmem_data.sleepTime;
}
}
int8_t EnigmaIOTNodeClass::getRSSI () {
return rtcmem_data.rssi;
}
void EnigmaIOTNodeClass::setLed (uint8_t led, time_t onTime) {
this->led = led;
ledOnTime = onTime;
}
void EnigmaIOTNodeClass::setResetPin (int pin) {
resetPin = pin;
}
void clearRtcData (rtcmem_data_t* data) {
memset (data->nodeKey, 0, KEY_LENGTH);
data->lastMessageCounter = 0;
data->nodeId = 0;
data->channel = 3;
memset (data->gateway, 0, 6);
memset (data->networkKey, 0, KEY_LENGTH);
data->nodeRegisterStatus = UNREGISTERED;
data->sleepy = false;
data->nodeKeyValid = false;
data->broadcastKeyRequested = false;
data->broadcastKeyValid = false;
DEBUG_DBG ("RTC Cleared");
}
void dumpRtcData (rtcmem_data_t* data, uint8_t* gateway = NULL) {
Serial.println ("RTC MEM DATA:");
if (data) {
Serial.printf (" -- CRC: %s\n", printHexBuffer ((uint8_t*)&(data->crc32), sizeof (uint32_t)));
Serial.printf (" -- Node Key: %s\n", printHexBuffer (data->nodeKey, KEY_LENGTH));
Serial.printf (" -- Node key is %svalid\n", data->nodeKeyValid ? "" : "NOT ");
Serial.printf (" -- Node status is %d: %s\n", data->nodeRegisterStatus, data->nodeRegisterStatus == REGISTERED ? "REGISTERED" : "NOT REGISTERED");
Serial.printf (" -- Node name: %s\n", data->nodeName);
Serial.printf (" -- Last message counter: %d\n", data->lastMessageCounter);
Serial.printf (" -- Last control counter: %d\n", data->lastControlCounter);
Serial.printf (" -- Last downlink counter: %d\n", data->lastDownlinkMsgCounter);
Serial.printf (" -- NodeID: %d\n", data->nodeId);
Serial.printf (" -- Channel: %d\n", data->channel);
Serial.printf (" -- RSSI: %d\n", data->rssi);
Serial.printf (" -- Network name: %s\n", data->networkName);
char gwAddress[ENIGMAIOT_ADDR_LEN * 3];
Serial.printf (" -- Gateway: %s\n", mac2str (data->gateway, gwAddress));
Serial.printf (" -- Comm errors: %d\n", data->commErrors);
if (gateway)
Serial.printf (" -- Gateway address: %s\n", mac2str (gateway, gwAddress));
Serial.printf (" -- Network Key: %s\n", printHexBuffer (data->networkKey, KEY_LENGTH));
Serial.printf (" -- Mode: %s\n", data->sleepy ? "sleepy" : "non sleepy");
Serial.printf (" -- Broadcast key: %s\n", printHexBuffer (data->broadcastKey, KEY_LENGTH));
Serial.printf (" -- Broadcast key is %s and %s requested\n",
data->broadcastKeyValid ? "valid" : "not valid",
data->broadcastKeyRequested ? "is" : "is not");
} else {
Serial.println ("rtcmem_data pointer is NULL");
}
}
#if USE_FLASH_INSTEAD_RTC
const char* RTC_DATA_FILE = "/context.bin";
bool EnigmaIOTNodeClass::loadRTCData () {
//FILESYSTEM.remove (RTC_DATA_FILE); // Only for testing
//bool file_correct = false;
time_t start_load = millis ();
FILESYSTEM.begin ();
rtcmem_data_t context;
if (FILESYSTEM.exists (RTC_DATA_FILE)) {
DEBUG_DBG ("Opening %s file", RTC_DATA_FILE);
File contextFile = FILESYSTEM.open (RTC_DATA_FILE, "r");
if (contextFile) {
DEBUG_DBG ("%s opened", RTC_DATA_FILE);
size_t size = contextFile.size ();
if (size != sizeof (rtcmem_data_t)) {
DEBUG_WARN ("File size error. Expected %d bytes. Got %d", sizeof (rtcmem_data_t), size);
contextFile.close ();
FILESYSTEM.remove (RTC_DATA_FILE);
return false;
}
size = contextFile.readBytes ((char*)&context, sizeof (rtcmem_data_t));
contextFile.close ();
if (size != sizeof (rtcmem_data_t)) {
DEBUG_WARN ("File read error. Expected %d bytes. Got %d", sizeof (rtcmem_data_t), size);
//contextFile.close ();
FILESYSTEM.remove (RTC_DATA_FILE);
return false;
}
if (!checkCRC ((uint8_t*)context.nodeKey, sizeof (rtcmem_data_t) - sizeof (uint32_t), &context.crc32)) {
DEBUG_WARN ("RTC Data is not valid. Wrong CRC");
//contextFile.close ();
FILESYSTEM.remove (RTC_DATA_FILE);
return false;
} else {
memcpy (&rtcmem_data, &context, sizeof (rtcmem_data_t));
node.setEncryptionKey (rtcmem_data.nodeKey);
node.setKeyValid (rtcmem_data.nodeKeyValid);
if (rtcmem_data.nodeKeyValid)
node.setKeyValidFrom (millis ());
node.setLastMessageCounter (rtcmem_data.lastMessageCounter);
node.setLastControlCounter (rtcmem_data.lastControlCounter);
node.setLastDownlinkMsgCounter (rtcmem_data.lastDownlinkMsgCounter);
node.setLastMessageTime ();
node.setNodeId (rtcmem_data.nodeId);
// setChannel (rtcmem_data.channel);
//channel = rtcmem_data.channel;
//memcpy (gateway, rtcmem_data.gateway, comm->getAddressLength ()); // setGateway
//memcpy (networkKey, rtcmem_data.networkKey, KEY_LENGTH);
node.setSleepy (rtcmem_data.sleepy);
node.setNodeName (rtcmem_data.nodeName);
// set default sleep time if it was not set
if (rtcmem_data.sleepy && rtcmem_data.sleepTime == 0) {
rtcmem_data.sleepTime = DEFAULT_SLEEP_TIME;
}
node.setStatus (rtcmem_data.nodeRegisterStatus);
DEBUG_DBG ("Set %s mode", node.getSleepy () ? "sleepy" : "non sleepy");
#if DEBUG_LEVEL >= VERBOSE
dumpRtcData (&rtcmem_data);
#endif
}
} else {
DEBUG_WARN ("Error opening file %s", RTC_DATA_FILE);
FILESYSTEM.remove (RTC_DATA_FILE);
return false;
}
} else {
DEBUG_WARN ("%s do not exist", RTC_DATA_FILE);
return false;
}
DEBUG_DBG ("Load process finished in %d ms", millis () - start_load);
return true;
}
#else
bool EnigmaIOTNodeClass::loadRTCData () {
#ifdef ESP8266
if (ESP.rtcUserMemoryRead (RTC_ADDRESS, (uint32_t*)&rtcmem_data, sizeof (rtcmem_data))) {
DEBUG_VERBOSE ("Read RTCData: %s", printHexBuffer ((uint8_t*)&rtcmem_data, sizeof (rtcmem_data)));
} else {
DEBUG_ERROR ("Error reading RTC memory");
clearRtcData (&rtcmem_data);
return false;
}
#elif defined ESP32
memcpy ((uint8_t*)&rtcmem_data, (uint8_t*)&rtcmem_data_storage, sizeof (rtcmem_data));
DEBUG_VERBOSE ("----- Read RTCData: %s", printHexBuffer ((uint8_t*)&rtcmem_data, sizeof (rtcmem_data)));
#endif
if (!checkCRC ((uint8_t*)rtcmem_data.nodeKey, sizeof (rtcmem_data) - sizeof (uint32_t), &rtcmem_data.crc32)) {
DEBUG_DBG ("RTC Data is not valid");
clearRtcData (&rtcmem_data);
return false;
} else {
node.setEncryptionKey (rtcmem_data.nodeKey);
node.setKeyValid (rtcmem_data.nodeKeyValid);
if (rtcmem_data.nodeKeyValid)
node.setKeyValidFrom (millis ());
node.setLastMessageCounter (rtcmem_data.lastMessageCounter);
node.setLastControlCounter (rtcmem_data.lastControlCounter);
node.setLastDownlinkMsgCounter (rtcmem_data.lastDownlinkMsgCounter);
node.setLastMessageTime ();
node.setNodeId (rtcmem_data.nodeId);
// setChannel (rtcmem_data.channel);
//channel = rtcmem_data.channel;
//memcpy (gateway, rtcmem_data.gateway, comm->getAddressLength ()); // setGateway
//memcpy (networkKey, rtcmem_data.networkKey, KEY_LENGTH);
node.setSleepy (rtcmem_data.sleepy);
node.setNodeName (rtcmem_data.nodeName);
// set default sleep time if it was not set
if (rtcmem_data.sleepy && rtcmem_data.sleepTime == 0) {
rtcmem_data.sleepTime = DEFAULT_SLEEP_TIME;
}
node.setStatus (rtcmem_data.nodeRegisterStatus);
DEBUG_DBG ("Set %s mode", node.getSleepy () ? "sleepy" : "non sleepy");
#if DEBUG_LEVEL >= VERBOSE
dumpRtcData (&rtcmem_data);
#endif
}
return true;
}
#endif
bool EnigmaIOTNodeClass::loadFlashData () {
//FILESYSTEM.remove (CONFIG_FILE); // Only for testing
bool json_correct = false;
if (FILESYSTEM.exists (CONFIG_FILE)) {
DEBUG_DBG ("Opening %s file", CONFIG_FILE);
File configFile = FILESYSTEM.open (CONFIG_FILE, "r");
if (configFile) {
DEBUG_DBG ("%s opened", CONFIG_FILE);
//size_t size = configFile.size ();
const size_t capacity = JSON_ARRAY_SIZE (32) + JSON_OBJECT_SIZE (7) + 110;
DynamicJsonDocument doc (capacity);
DeserializationError error = deserializeJson (doc, configFile);
if (error) {
DEBUG_ERROR ("Failed to parse file");
} else {
DEBUG_DBG ("JSON file parsed");
}
configFile.close ();
if (doc.containsKey("type")){
if (!strcmp("node",doc["type"])) {
if (doc.containsKey ("networkName") && doc.containsKey ("networkKey")
&& doc.containsKey ("sleepTime")) {
json_correct = true;
}
} else {
FILESYSTEM.remove (CONFIG_FILE);
DEBUG_ERROR ("Wrong configuration. Removing file %s", CONFIG_FILE);
return false;
}
}
strlcpy (rtcmem_data.networkName, doc["networkName"] | "", sizeof (rtcmem_data.networkName));
rtcmem_data.sleepTime = doc["sleepTime"].as<int> ();
rtcmem_data.sleepy = !(rtcmem_data.sleepTime == 0);
memset (rtcmem_data.networkKey, 0, KEY_LENGTH);
JsonArray netKeyJson = doc["networkKey"];
if (netKeyJson.size () != KEY_LENGTH) {
DEBUG_WARN ("Error in stored network key. Expected length: %d, actual length %d", KEY_LENGTH, netKeyJson.size ());
return false;
}
for (int i = 0; i < KEY_LENGTH; i++) {
rtcmem_data.networkKey[i] = netKeyJson[i].as<int> ();
}
DEBUG_DBG ("Network Key dump: %s", printHexBuffer (rtcmem_data.networkKey, KEY_LENGTH));
strncpy ((char*)rtcmem_data.nodeName, doc["nodeName"] | "", NODE_NAME_LENGTH);
node.setNodeName (rtcmem_data.nodeName);
uint8_t gwAddr[ENIGMAIOT_ADDR_LEN];
char gwAddrStr[ENIGMAIOT_ADDR_LEN * 3];
if (doc.containsKey ("gateway")) {
strncpy (gwAddrStr, doc["gateway"], sizeof (gwAddrStr));
str2mac (gwAddrStr, gwAddr);
memcpy (rtcmem_data.gateway, gwAddr, 6);
}
if (json_correct) {
DEBUG_VERBOSE ("Configuration successfuly read");
}
DEBUG_DBG ("==== EnigmaIOT Node Configuration ====");
DEBUG_DBG ("Network name: %s", rtcmem_data.networkName);
DEBUG_DBG ("Sleep time: %u", rtcmem_data.sleepTime);
DEBUG_DBG ("Node name: %s", rtcmem_data.nodeName);
DEBUG_DBG ("Gateway: %s", gwAddrStr);
DEBUG_VERBOSE ("Network key: %s", printHexBuffer (rtcmem_data.networkKey, KEY_LENGTH));
String output;
serializeJsonPretty (doc, output);
DEBUG_DBG ("JSON file %s", output.c_str ());
}
} else {
DEBUG_WARN ("%s do not exist", CONFIG_FILE);
}
return json_correct;
}
bool EnigmaIOTNodeClass::saveFlashData (bool fsOpen) {
if (configCleared)
return false;
if (!fsOpen)
FILESYSTEM.begin ();
File configFile = FILESYSTEM.open (CONFIG_FILE, "w");
if (!configFile) {
DEBUG_WARN ("failed to open config file %s for writing", CONFIG_FILE);
return false;
}
const size_t capacity = JSON_ARRAY_SIZE (32) + JSON_OBJECT_SIZE (7) + 110;
DynamicJsonDocument doc (capacity);
char gwAddrStr[ENIGMAIOT_ADDR_LEN * 3];
mac2str (rtcmem_data.gateway, gwAddrStr);
doc["type"] = "node";
doc["networkName"] = rtcmem_data.networkName;
JsonArray netKeyJson = doc.createNestedArray ("networkKey");
for (int i = 0; i < KEY_LENGTH; i++) {
netKeyJson.add (rtcmem_data.networkKey[i]);
}
doc["sleepTime"] = rtcmem_data.sleepTime;
doc["gateway"] = gwAddrStr;
doc["nodeName"] = rtcmem_data.nodeName;
if (serializeJson (doc, configFile) == 0) {
DEBUG_ERROR ("Failed to write to file");
configFile.close ();
//FILESYSTEM.remove (CONFIG_FILE); // Testing
return false;
}
String output;
serializeJsonPretty (doc, output);
DEBUG_DBG ("%s", output.c_str ());
configFile.flush ();
//size_t size = configFile.size ();
configFile.close ();
DEBUG_DBG ("Configuration saved to flash. %u bytes", configFile.size ());
#if DEBUG_LEVEL >= DBG
dumpRtcData (&rtcmem_data);
#endif
if (!fsOpen)
FILESYSTEM.end ();
return true;
}
#if USE_FLASH_INSTEAD_RTC
bool EnigmaIOTNodeClass::saveRTCData () {
time_t start_save = millis ();
if (configCleared)
return false;
rtcmem_data.crc32 = calculateCRC32 ((uint8_t*)rtcmem_data.nodeKey, sizeof (rtcmem_data) - sizeof (uint32_t));
File contextFile = FILESYSTEM.open (RTC_DATA_FILE, "w");
if (!contextFile) {
DEBUG_WARN ("failed to open config file %s for writing", RTC_DATA_FILE);
return false;
}
contextFile.write ((uint8_t*)&rtcmem_data, sizeof (rtcmem_data));
contextFile.flush ();
size_t size = contextFile.size ();
contextFile.close ();
DEBUG_DBG ("Write configuration data to file %s in flash. %u bytes", RTC_DATA_FILE, size);
DEBUG_VERBOSE ("Write RTCData: %s", printHexBuffer ((uint8_t*)&rtcmem_data, sizeof (rtcmem_data)));
#if DEBUG_LEVEL >= VERBOSE
dumpRtcData (&rtcmem_data);
#endif
DEBUG_DBG ("Save process finished in %d ms", millis () - start_save);
return true;
}
#else
bool EnigmaIOTNodeClass::saveRTCData () {
if (configCleared)
return false;
if (protectOTA || otaRunning) {
DEBUG_WARN ("Cannot write to RTC memory");
return true;
}
#ifdef ESP8266
rtcmem_data.crc32 = calculateCRC32 ((uint8_t*)rtcmem_data.nodeKey, sizeof (rtcmem_data) - sizeof (uint32_t));
if (ESP.rtcUserMemoryWrite (RTC_ADDRESS, (uint32_t*)&rtcmem_data, sizeof (rtcmem_data))) {
DEBUG_DBG ("Write configuration data to RTC memory");
#if DEBUG_LEVEL >= VERBOSE
DEBUG_VERBOSE ("Write RTCData: %s", printHexBuffer ((uint8_t*)&rtcmem_data, sizeof (rtcmem_data)));
dumpRtcData (&rtcmem_data);
#endif
return true;
}
#elif defined ESP32
rtcmem_data.crc32 = calculateCRC32 ((uint8_t*)rtcmem_data.nodeKey, sizeof (rtcmem_data) - sizeof (uint32_t));
memcpy ((uint8_t*)&rtcmem_data_storage, (uint8_t*)&rtcmem_data, sizeof (rtcmem_data));
rtcmem_data_storage.crc32 = calculateCRC32 ((uint8_t*)rtcmem_data_storage.nodeKey, sizeof (rtcmem_data) - sizeof (uint32_t));
DEBUG_VERBOSE ("Write RTCData: %s", printHexBuffer ((uint8_t*)&rtcmem_data, sizeof (rtcmem_data)));
#if DEBUG_LEVEL >= VERBOSE
dumpRtcData (&rtcmem_data);
#endif
return true;
#endif
return false;
}
#endif
void EnigmaIOTNodeClass::clearFlash () {
if (!FILESYSTEM.begin ()) {
DEBUG_ERROR ("Error on SPIFFS.begin()");
}
if (FILESYSTEM.format()) {
DEBUG_DBG ("Filesystem formatted");
}
/*if (FILESYSTEM.remove (CONFIG_FILE)) {
DEBUG_DBG ("%s deleted", CONFIG_FILE);
}*/ else {
DEBUG_ERROR ("Error on SPIFFS.format()", CONFIG_FILE);
}
FILESYSTEM.end ();
}
bool EnigmaIOTNodeClass::configWiFiManager (rtcmem_data_t* data) {
AsyncWebServer server (80);
DNSServer dns;
//regex_t regex;
bool regexResult = true;
//char networkKey[33] = "";
char sleepy[5] = "10";
//char networkName[NETWORK_NAME_LENGTH] = "";
char nodeName[NODE_NAME_LENGTH] = "";
wifiManager = new AsyncWiFiManager (&server, &dns);
#if DEBUG_LEVEL == NONE
wifiManager->setDebugOutput (false);
#endif
//AsyncWiFiManagerParameter networkNameParam ("netname", "Network name", networkName, (int)NETWORK_NAME_LENGTH, "required type=\"text\" maxlength=20");
//AsyncWiFiManagerParameter netKeyParam ("netkey", "NetworkKey", networkKey, 33, "required type=\"password\" maxlength=32");
AsyncWiFiManagerParameter sleepyParam ("sleepy", "Sleep Time", sleepy, 5, "required type=\"number\" min=\"0\" max=\"13600\" step=\"1\"");
AsyncWiFiManagerParameter nodeNameParam ("nodename", "Node Name", nodeName, NODE_NAME_LENGTH, "type=\"text\" pattern=\"^[^/\\\\]+$\" maxlength=32");
wifiManager->setCustomHeadElement ("<style>input:invalid {border: 2px dashed red;input:valid{border: 2px solid black;}</style>");
//wifiManager->addParameter (&networkNameParam);
//wifiManager->addParameter (&netKeyParam);
wifiManager->addParameter (&sleepyParam);
wifiManager->addParameter (&nodeNameParam);
if (notifyWiFiManagerStarted) {
notifyWiFiManagerStarted ();
}
wifiManager->setConnectTimeout (30);
wifiManager->setBreakAfterConfig (true);
wifiManager->setTryConnectDuringConfigPortal (false);
char apname[64];
#ifdef ESP8266
snprintf (apname, 64, "EnigmaIoTNode%06x", ESP.getChipId ());
//String apname = "EnigmaIoTNode" + String (ESP.getChipId (), 16);
#elif defined ESP32
snprintf (apname, 64, "EnigmaIoTNode%06x", (uint32_t)(ESP.getEfuseMac () & (uint64_t)0x0000000000FFFFFF));
//String apname = "EnigmaIoTNode" + String (ESP.getEfuseMac (), 16);
#endif
DEBUG_VERBOSE ("Start AP: %s", apname);
boolean result = wifiManager->startConfigPortal (apname, NULL);
if (result) {
DEBUG_DBG ("==== Config Portal result ====");
DEBUG_DBG ("Network Name: %s", WiFi.SSID ().c_str ());
#ifdef ESP8266
station_config wifiConfig;
if (!wifi_station_get_config (&wifiConfig)) {
DEBUG_WARN ("Error getting WiFi config");
}
DEBUG_DBG ("WiFi password: %s", wifiConfig.password);
const char* netkey = (char*)(wifiConfig.password);
#elif defined ESP32
wifi_config_t wifiConfig;
if (!esp_wifi_get_config (WIFI_IF_STA, &wifiConfig)) {
DEBUG_WARN ("Error getting WiFi config");
}
DEBUG_WARN ("WiFi password: %.*s", 64, wifiConfig.sta.password);
const char* netkey = (char*)(wifiConfig.sta.password);
#endif
DEBUG_DBG ("Network Key: %s", netkey);
DEBUG_DBG ("Sleppy time: %s", sleepyParam.getValue ());
DEBUG_DBG ("Node Name: %s", nodeNameParam.getValue ());
data->lastMessageCounter = 0;
strncpy ((char*)(data->networkKey), netkey, KEY_LENGTH);
DEBUG_DBG ("Stored network key before hash: %.*s", KEY_LENGTH, (char*)(data->networkKey));
CryptModule::getSHA256 (data->networkKey, KEY_LENGTH);
DEBUG_DBG ("Calculated network key: %s", printHexBuffer (data->networkKey, KEY_LENGTH));
data->nodeRegisterStatus = UNREGISTERED;
//const char* netName = WiFi.SSID ().c_str ();
DEBUG_DBG ("Temp network name: %s", WiFi.SSID ().c_str ());
strncpy (data->networkName, WiFi.SSID ().c_str (), NETWORK_NAME_LENGTH - 1);
DEBUG_DBG ("Stored network name: %s", data->networkName);
#ifdef ESP32
std::regex sleepTimeRegex ("(\\d)+");
regexResult = std::regex_match (sleepyParam.getValue (), sleepTimeRegex);
if (regexResult) {
#endif
DEBUG_DBG ("Sleep time check ok");
int sleepyVal = atoi (sleepyParam.getValue ());
if (sleepyVal > 0) {
data->sleepy = true;
}
data->sleepTime = sleepyVal;
#ifdef ESP32
} else {
DEBUG_WARN ("Sleep time parameter error");
result = false;
}
#endif
//char tempStr[NODE_NAME_LENGTH];
//strncpy (tempStr, nodeNameParam.getValue (), NODE_NAME_LENGTH - 1);
#ifdef ESP32
std::regex nodeNameRegex ("^[^/\\\\]+$");
regexResult = std::regex_match (nodeNameParam.getValue (), nodeNameRegex);
#elif defined ESP8266
if (strstr (nodeNameParam.getValue (), "/")) {
regexResult = false;
DEBUG_WARN ("Node name parameter error. Contains '/'");
} else if (strstr (nodeNameParam.getValue (), "\\")) {
regexResult = false;
DEBUG_WARN ("Node name parameter error. Contains '\\'");
}
#endif
if (regexResult) {
strncpy (data->nodeName, nodeNameParam.getValue (), NODE_NAME_LENGTH);
DEBUG_DBG ("Node name: %s", data->nodeName);
} else {
DEBUG_WARN ("Node name parameter error");
result = false;
}
data->nodeKeyValid = false;
data->crc32 = calculateCRC32 ((uint8_t*)(data->nodeKey), sizeof (rtcmem_data_t) - sizeof (uint32_t));
}
if (notifyWiFiManagerExit) {
notifyWiFiManagerExit (result);
}
delete (wifiManager);
return result;
}
void flashLed (void* led) {
#ifdef ESP8266
digitalWrite (*(int*)led, !digitalRead (*(int*)led));
#elif defined ESP32
bool led_on = !digitalRead (localLed);
DEBUG_VERBOSE ("Change LED %d to %d", localLed, led_on);
digitalWrite (localLed, led_on);
#endif
}
void startFlash (time_t period) {
#ifdef ESP32
//static int id = 1;
DEBUG_INFO ("Start flash");
if (!nodeConnectionLedFlashing) {
nodeConnectionLedFlashing = true;
ledTimer = xTimerCreate ("led_flash", pdMS_TO_TICKS (period), pdTRUE, (void*)0, &flashLed);
if (xTimerStart (ledTimer, 0) != pdPASS) {
DEBUG_WARN ("Problem starting LED timer");
}
}
#elif defined (ESP8266)
ets_timer_disarm (&ledTimer);
if (!nodeConnectionLedFlashing) {
nodeConnectionLedFlashing = true;
ets_timer_arm_new (&ledTimer, period, true, true);
}
#endif // ESP32
}
void stopFlash () {
#ifdef ESP32
if (nodeConnectionLedFlashing) {
nodeConnectionLedFlashing = false;
xTimerStop (ledTimer, 0);
xTimerDelete (ledTimer, 0);
}
#elif defined(ESP8266)
if (nodeConnectionLedFlashing) {
nodeConnectionLedFlashing = false;
ets_timer_disarm (&ledTimer);
digitalWrite (localLed, LED_OFF);
}
#endif // ESP32
}
void EnigmaIOTNodeClass::startIdentifying (time_t period) {
identifyStart = millis ();
indentifying = true;
startFlash (period);
}
void EnigmaIOTNodeClass::stopIdentifying () {
indentifying = false;
stopFlash ();
}
void EnigmaIOTNodeClass::checkResetButton () {
if (resetPin > 0) {
pinMode (resetPin, INPUT_PULLUP);
digitalWrite (led, LED_ON); // Turn on LED
if (digitalRead (resetPin) == LOW) { // If pin is grounded
time_t resetPinGrounded = millis ();
while (digitalRead (resetPin) == LOW) {
if (millis () - resetPinGrounded > RESET_PIN_DURATION) {
DEBUG_WARN ("Produce reset");
digitalWrite (led, LED_OFF); // Turn off LED
startFlash (50);
clearFlash ();
clearRTC ();
delay (5000);
ESP.restart ();
}
delay (50);
}
}
}
}
void EnigmaIOTNodeClass::begin (Comms_halClass* comm, uint8_t* gateway, uint8_t* networkKey, bool useCounter, bool sleepy) {
cycleStartedTime = 0; // Calculate time from start
pinMode (led, OUTPUT);
#ifdef ESP8266
ets_timer_setfn (&ledTimer, flashLed, (void*)&led);
#endif
localLed = led;
checkResetButton ();
// startFlash (100); // Do not flash during setup for less battery drain
digitalWrite (led, LED_OFF);
this->comm = comm;
this->useCounter = useCounter;
node.setInitAsSleepy (sleepy);
node.setSleepy (sleepy);
DEBUG_DBG ("Set %s mode: %s", node.getSleepy () ? "sleepy" : "non sleepy", sleepy ? "sleepy" : "non sleepy");
if (loadRTCData () && rtcmem_data.commErrors < COMM_ERRORS_BEFORE_SCAN) { // If data present on RTC node has waked up or it is just configured, continue
#if DEBUG_LEVEL >= DBG
char gwAddress[ENIGMAIOT_ADDR_LEN * 3];
DEBUG_DBG ("RTC data loaded. Gateway: %s", mac2str (rtcmem_data.gateway, gwAddress));
DEBUG_DBG ("Own address: %s", mac2str (node.getMacAddress (), gwAddress));
#endif
} else { // No RTC data, first boot or not configured
if (gateway && networkKey) { // If connection data has been passed to library
DEBUG_DBG ("EnigmaIot started with config data con begin() call");
memcpy (rtcmem_data.gateway, gateway, comm->getAddressLength ()); // setGateway
memcpy (rtcmem_data.networkKey, networkKey, KEY_LENGTH); // setNetworkKey
CryptModule::getSHA256 (rtcmem_data.networkKey, KEY_LENGTH);
rtcmem_data.nodeKeyValid = false;
//rtcmem_data.channel = channel;
rtcmem_data.sleepy = sleepy;
rtcmem_data.nodeRegisterStatus = UNREGISTERED;
} else { // Try read from flash
DEBUG_INFO ("Starting from Flash");
if (!FILESYSTEM.begin ()) {
DEBUG_ERROR ("Error mounting flash");
if (FILESYSTEM.format ()) {
DEBUG_INFO ("SPIFFS formatted");
} else {
DEBUG_ERROR ("Error formatting SPIFFS");
}
delay (2500);
ESP.restart ();
//return;
} else {
DEBUG_INFO ("SPIFFS mounted");
}
if (loadFlashData ()) { // If data present on flash, read and continue
node.setStatus (UNREGISTERED);
DEBUG_DBG ("Flash data loaded");
uint8_t prevGwAddr[ENIGMAIOT_ADDR_LEN];
memcpy (prevGwAddr, rtcmem_data.gateway, 6);
if (searchForGateway (&rtcmem_data), true) {
//DEBUG_DBG ("Found gateway. Storing");
rtcmem_data.commErrors = 0;
}
} else { // Configuration empty. Enter config AP mode
DEBUG_DBG ("No flash data present. Starting Configuration AP");
bool result = configWiFiManager (&rtcmem_data);
if (result) {
DEBUG_DBG ("Got configuration. Searching for Gateway");
if (!searchForGateway (&rtcmem_data), true) {
DEBUG_DBG ("Found EnigmaIOT Gateway. Storing configuration");
if (!saveFlashData (true)) {
DEBUG_ERROR ("Error saving data on flash");
}
FILESYSTEM.end ();
ESP.restart ();
return;
}
FILESYSTEM.end ();
ESP.restart ();
} else { // Configuration error
DEBUG_ERROR ("Configuration error. Restarting");
ESP.restart ();
}
}
}
}
initWiFi (rtcmem_data.channel, rtcmem_data.networkName);
comm->begin (rtcmem_data.gateway, rtcmem_data.channel);
comm->onDataRcvd (rx_cb);
comm->onDataSent (tx_cb);
#ifdef ESP8266
wifi_set_channel (rtcmem_data.channel);
#elif defined ESP32
esp_err_t err_ok;
if ((err_ok = esp_wifi_set_promiscuous (true))) {
DEBUG_ERROR ("Error setting promiscuous mode: %s", esp_err_to_name (err_ok));
}
if ((err_ok = esp_wifi_set_channel (rtcmem_data.channel, WIFI_SECOND_CHAN_NONE))) {
DEBUG_ERROR ("Error setting wifi channel: %s", esp_err_to_name (err_ok));
}
if ((err_ok = esp_wifi_set_promiscuous (false))) {
DEBUG_ERROR ("Error setting promiscuous mode off: %s", esp_err_to_name (err_ok));
}
#endif
DEBUG_DBG ("Comms started. Channel %u", rtcmem_data.channel);
}
#ifdef ESP32
int scanGatewaySSID (char* name, int& wifiIndex) {
uint32_t scanStarted;
int16_t numAP = 0;
const int MAX_INDEXES = 10;
int numFound = 0;
int indexes[MAX_INDEXES];
if (!name) {
DEBUG_WARN ("SSID Name is NULL");
return 0;
}
scanStarted = millis ();
numAP = WiFi.scanNetworks (false, false, false, 300U);
DEBUG_DBG ("Found %d APs in %lu ms", numAP, millis () - scanStarted);
DEBUG_DBG ("Scan finished. Result = %d", WiFi.scanComplete ());
while (!(WiFi.scanComplete ()) && (millis () - scanStarted) > 1500) { //
#if DEBUG_LEVEL >= DBG
delay (250);
Serial.printf ("%lu.", millis () - scanStarted);
#else
delay (50);
#endif
}
DEBUG_DBG ("Scan finished. Result = %d", WiFi.scanComplete ());
DEBUG_DBG ("Found %d APs in %lu ms", numAP, millis () - scanStarted);
wifi_ap_record_t* wifiAP;
for (int i = 0; i < numAP; i++) {
wifiAP = (wifi_ap_record_t*)WiFi.getScanInfoByIndex (i);
DEBUG_DBG ("Found AP %.*s with BSSID " MACSTR " and RSSI %d dBm", 32, wifiAP->ssid, MAC2STR (wifiAP->bssid), wifiAP->rssi);
if (!strncmp (name, (char*)(wifiAP->ssid), 32)) {
indexes[numFound] = i;
numFound++;
if (numFound >= MAX_INDEXES) {
break;
}
}
}
wifiIndex = indexes[0];
return numFound;
}
#endif
bool EnigmaIOTNodeClass::searchForGateway (rtcmem_data_t* data, bool shouldStoreData) {
DEBUG_DBG ("Searching for AP %s", data->networkName);
//WiFi.mode (WIFI_STA);
int numWifi = 0;
int wifiIndex = 0;
#ifdef ESP8266
time_t scanStarted = millis ();
numWifi = WiFi.scanNetworks (false, false, 0, (uint8_t*)(data->networkName));
while (!(WiFi.scanComplete () || (millis () - scanStarted) > 1500)) {
#if DEBUG_LEVEL >= DBG
delay (250);
Serial.printf ("%lu.", millis () - scanStarted);
#else
delay (50);
#endif
}
WiFiMode_t mode = WiFi.getMode ();
DEBUG_DBG ("WiFi mode is %d. Restarting network interface after scan", mode);
WiFi.mode (WIFI_OFF);
WiFi.mode (mode);
#elif defined ESP32
numWifi = scanGatewaySSID (data->networkName, wifiIndex);
#endif // ESP8266
uint8_t prevGwAddr[ENIGMAIOT_ADDR_LEN];
memcpy (prevGwAddr, data->gateway, 6);
if (numWifi > 0) {
DEBUG_INFO ("Gateway %s found: %d", data->networkName, numWifi);
DEBUG_INFO ("BSSID: %s", WiFi.BSSIDstr (wifiIndex).c_str ());
DEBUG_INFO ("Channel: %d", WiFi.channel (wifiIndex));
DEBUG_INFO ("RSSI: %d", WiFi.RSSI (wifiIndex));
data->channel = WiFi.channel (wifiIndex);
data->rssi = WiFi.RSSI (wifiIndex);
memcpy (data->gateway, WiFi.BSSID (wifiIndex), 6);
if (shouldStoreData) {
DEBUG_DBG ("Found gateway. Storing");
if (!saveRTCData ()) {
DEBUG_ERROR ("Error saving data on RTC");
}
if (memcmp (prevGwAddr, data->gateway, 6)) {
if (!saveFlashData ()) {
DEBUG_ERROR ("Error saving data on flash");
}
}
}
WiFi.scanDelete ();
#ifdef ESP8266
wifi_set_channel (data->channel);
#elif defined ESP32
esp_err_t err_ok;
if ((err_ok = esp_wifi_set_promiscuous (true))) {
DEBUG_ERROR ("Error setting promiscuous mode: %s", esp_err_to_name (err_ok));
}
if ((err_ok = esp_wifi_set_channel (data->channel, WIFI_SECOND_CHAN_NONE))) {
DEBUG_ERROR ("Error setting wifi channel: %s", esp_err_to_name (err_ok));
}
if ((err_ok = esp_wifi_set_promiscuous (false))) {
DEBUG_ERROR ("Error setting promiscuous mode off: %s", esp_err_to_name (err_ok));
}
#endif
requestReportRSSI = true;
return true;
}
DEBUG_WARN ("Gateway %s not found", data->networkName);
return false;
}
void EnigmaIOTNodeClass::stop () {
comm->stop ();
DEBUG_DBG ("Communication layer uninitalized");
}
bool EnigmaIOTNodeClass::setNodeAddress (uint8_t address[ENIGMAIOT_ADDR_LEN]) {
node.setMacAddress (address);
return true;
}
void EnigmaIOTNodeClass::setSleepTime (uint32_t sleepTime, bool forceSleepForever) {
if (node.getInitAsSleepy ()) {
#ifdef ESP8266 // ESP32 does not have this limitation
uint64_t maxSleepTime = (ESP.deepSleepMax () / (uint64_t)1000000);
#endif
if (sleepTime == 0 && !forceSleepForever) {
node.setSleepy (false);
//rtcmem_data.sleepy = false; // This setting is temporary, do not store
} else if (sleepTime
#ifdef ESP8266
< maxSleepTime
#endif
) {
node.setSleepy (true);
rtcmem_data.sleepTime = sleepTime;
}
#ifdef ESP8266
else {
DEBUG_DBG ("Max sleep time is %lu", (uint32_t)maxSleepTime);
node.setSleepy (true);
rtcmem_data.sleepTime = (uint32_t)maxSleepTime;
}
#endif
this->sleepTime = (uint64_t)rtcmem_data.sleepTime * (uint64_t)1000000;
DEBUG_DBG ("Sleep time set to %d. Sleepy mode is %s",
rtcmem_data.sleepTime,
node.getSleepy () ? "sleepy" : "non sleepy");
} else {
DEBUG_WARN ("Cannot set sleep time to %u seconds as this node started as non sleepy", sleepTime);
}
}
bool EnigmaIOTNodeClass::reportRSSI () {
uint8_t buffer[MAX_MESSAGE_LENGTH];
uint8_t bufLength;
DEBUG_DBG ("Report RSSI and channel");
buffer[0] = control_message_type::RSSI_ANS;
buffer[1] = rtcmem_data.rssi;
buffer[2] = rtcmem_data.channel;
bufLength = 3;
if (sendData (buffer, bufLength, true)) {
DEBUG_DBG ("Sleep time is %d seconds", sleepTime / 1000000);
DEBUG_VERBOSE ("Data: %s", printHexBuffer (buffer, bufLength));
return true;
} else {
DEBUG_WARN ("Error sending version response");
return false;
}
}
void EnigmaIOTNodeClass::handle () {
static unsigned long blueOntime;
// Locate gateway address, channel and rssi
if (requestSearchGateway) {
requestSearchGateway = false;
requestReportRSSI = true;
searchForGateway (&rtcmem_data, true);
}