/
Web.cpp
1925 lines (1729 loc) · 67.1 KB
/
Web.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
#include <Arduino.h>
#include <WiFi.h>
#include <Update.h>
#include <nvsDump.h>
#include <esp_task_wdt.h>
#include "soc/timer_group_struct.h"
#include "soc/timer_group_reg.h"
#include "freertos/ringbuf.h"
#include "ESPAsyncWebServer.h"
#include "AsyncJson.h"
#include "ArduinoJson.h"
#include "settings.h"
#include "AudioPlayer.h"
#include "Battery.h"
#include "Cmd.h"
#include "Common.h"
#include "Ftp.h"
#include "Led.h"
#include "Log.h"
#include "MemX.h"
#include "Mqtt.h"
#include "Rfid.h"
#include "SdCard.h"
#include "System.h"
#include "Web.h"
#include "Wlan.h"
#include "revision.h"
#include "Rfid.h"
#include "HallEffectSensor.h"
#include "HTMLbinary.h"
typedef struct {
char nvsKey[13];
char nvsEntry[275];
} nvs_t;
AsyncWebServer wServer(80);
AsyncWebSocket ws("/ws");
AsyncEventSource events("/events");
static bool webserverStarted = false;
static const uint32_t chunk_size = 16384; // bigger chunks increase write-performance to SD-Card
static const uint32_t nr_of_buffers = 2; // at least two buffers. No speed improvement yet with more than two.
uint8_t buffer[nr_of_buffers][chunk_size];
volatile uint32_t size_in_buffer[nr_of_buffers];
volatile bool buffer_full[nr_of_buffers];
uint32_t index_buffer_write = 0;
uint32_t index_buffer_read = 0;
static QueueHandle_t explorerFileUploadStatusQueue;
static TaskHandle_t fileStorageTaskHandle;
void Web_DumpSdToNvs(const char *_filename);
static void handleUpload(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final);
static void explorerHandleFileUpload(AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final);
static void explorerHandleFileStorageTask(void *parameter);
static void explorerHandleListRequest(AsyncWebServerRequest *request);
static void explorerHandleDownloadRequest(AsyncWebServerRequest *request);
static void explorerHandleDeleteRequest(AsyncWebServerRequest *request);
static void explorerHandleCreateRequest(AsyncWebServerRequest *request);
static void explorerHandleRenameRequest(AsyncWebServerRequest *request);
static void explorerHandleAudioRequest(AsyncWebServerRequest *request);
static void handleGetSavedSSIDs(AsyncWebServerRequest *request);
static void handlePostSavedSSIDs(AsyncWebServerRequest *request, JsonVariant &json);
static void handleDeleteSavedSSIDs(AsyncWebServerRequest *request);
static void handleGetActiveSSID(AsyncWebServerRequest *request);
static void handleGetWiFiConfig(AsyncWebServerRequest *request);
static void handlePostWiFiConfig(AsyncWebServerRequest *request, JsonVariant &json);
static void handleCoverImageRequest(AsyncWebServerRequest *request);
static void handleWiFiScanRequest(AsyncWebServerRequest *request);
static void handleGetRFIDRequest(AsyncWebServerRequest *request);
static void handlePostRFIDRequest(AsyncWebServerRequest *request, JsonVariant &json);
static void handleDeleteRFIDRequest(AsyncWebServerRequest *request);
static void handleGetInfo(AsyncWebServerRequest *request);
static void handleGetSettings(AsyncWebServerRequest *request);
static void handlePostSettings(AsyncWebServerRequest *request, JsonVariant &json);
static void onWebsocketEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len);
static void settingsToJSON(JsonObject obj, String section);
static bool JSONToSettings(JsonObject obj);
static void webserverStart(void);
// If PSRAM is available use it allocate memory for JSON-objects
struct SpiRamAllocator {
void* allocate(size_t size) {
return ps_malloc(size);
}
void deallocate(void* pointer) {
free(pointer);
}
};
using SpiRamJsonDocument = BasicJsonDocument<SpiRamAllocator>;
static void serveProgmemFiles(const String& uri, const String& contentType, const uint8_t *content, size_t len) {
wServer.on(uri.c_str(), HTTP_GET, [contentType, content, len](AsyncWebServerRequest *request) {
AsyncWebServerResponse *response;
// const bool etag = request->hasHeader("if-None-Match") && request->getHeader("if-None-Match")->value().equals(gitRevShort);
const bool etag = false;
if (etag)
response = request->beginResponse(304);
else {
response = request->beginResponse_P(200, contentType, content, len);
response->addHeader("Content-Encoding", "gzip");
}
// response->addHeader("Cache-Control", "public, max-age=31536000, immutable");
// response->addHeader("ETag", gitRevShort); // use git revision as digest
request->send(response);
});
}
class OneParamRewrite : public AsyncWebRewrite
{
protected:
String _urlPrefix;
int _paramIndex;
String _paramsBackup;
public:
OneParamRewrite(const char* from, const char* to)
: AsyncWebRewrite(from, to) {
_paramIndex = _from.indexOf('{');
if( _paramIndex >=0 && _from.endsWith("}")) {
_urlPrefix = _from.substring(0, _paramIndex);
int index = _params.indexOf('{');
if(index >= 0) {
_params = _params.substring(0, index);
}
} else {
_urlPrefix = _from;
}
_paramsBackup = _params;
}
bool match(AsyncWebServerRequest *request) override {
if(request->url().startsWith(_urlPrefix)) {
if(_paramIndex >= 0) {
_params = _paramsBackup + request->url().substring(_paramIndex);
} else {
_params = _paramsBackup;
}
return true;
} else {
return false;
}
}
};
// List all key in NVS for a given namespace
// callback function is called for every key with userdefined data object
bool listNVSKeys(const char *_namespace, void* data, bool (*callback)(const char * key, void* data)) {
Led_SetPause(true); // Workaround to prevent exceptions due to Neopixel-signalisation while NVS-write
esp_partition_iterator_t pi; // Iterator for find
const esp_partition_t *nvs; // Pointer to partition struct
esp_err_t result = ESP_OK;
const char *partname = "nvs";
uint8_t pagenr = 0; // Page number in NVS
uint8_t i; // Index in Entry 0..125
uint8_t bm; // Bitmap for an entry
uint32_t offset = 0; // Offset in nvs partition
uint8_t namespace_ID; // Namespace ID found
pi = esp_partition_find(ESP_PARTITION_TYPE_DATA, // Get partition iterator for
ESP_PARTITION_SUBTYPE_ANY, // this partition
partname);
if (pi) {
nvs = esp_partition_get(pi); // Get partition struct
esp_partition_iterator_release(pi); // Release the iterator
Log_Printf(LOGLEVEL_DEBUG, "Partition %s found, %d bytes", partname, nvs->size);
} else {
Log_Printf(LOGLEVEL_ERROR, "Partition %s not found!", partname);
return false;
}
namespace_ID = FindNsID(nvs, _namespace); // Find ID of our namespace in NVS
while (offset < nvs->size) {
result = esp_partition_read(nvs, offset, // Read 1 page in nvs partition
&buf,
sizeof(nvs_page));
if (result != ESP_OK) {
Log_Println("Error reading NVS!", LOGLEVEL_ERROR);
return false;
}
i = 0;
while (i < 126) {
bm = (buf.Bitmap[i / 4] >> ((i % 4) * 2)) & 0x03; // Get bitmap for this entry
if (bm == 2) {
if ((namespace_ID == 0xFF) || // Show all if ID = 0xFF
(buf.Entry[i].Ns == namespace_ID)) { // otherwise just my namespace
if (isNumber(buf.Entry[i].Key)) {
if (!callback(buf.Entry[i].Key, data)) {
return false;
}
}
}
i += buf.Entry[i].Span; // Next entry
} else {
i++;
}
}
offset += sizeof(nvs_page); // Prepare to read next page in nvs
pagenr++;
}
Led_SetPause(false);
return true;
}
// callback for writing a NVS entry to file
bool DumpNvsToSdCallback(const char * key, void* data) {
String s = gPrefsRfid.getString(key);
File *file = (File *) data;
file->printf("%s%s%s%s\n", stringOuterDelimiter, key, stringOuterDelimiter, s.c_str());
return true;
}
// Dumps all RFID-entries from NVS into a file on SD-card
bool Web_DumpNvsToSd(const char *_namespace, const char *_destFile) {
File file = gFSystem.open(_destFile, FILE_WRITE);
if (!file) {
return false;
}
// write UTF-8 BOM
file.write(0xEF);
file.write(0xBB);
file.write(0xBF);
// list all NVS keys
bool success = listNVSKeys(_namespace, &file, DumpNvsToSdCallback);
file.close();
return success;
}
// First request will return 0 results unless you start scan from somewhere else (loop/setup)
// Do not request more often than 3-5 seconds
static void handleWiFiScanRequest(AsyncWebServerRequest *request) {
String json = "[";
int n = WiFi.scanComplete();
if (n == -2) {
// -2 if scan not triggered
WiFi.scanNetworks(true, false, true, 120);
} else if(n) {
for (int i = 0; i < n; ++i) {
if (i > 9) {
break;
}
// calculate RSSI as quality in percent
int quality;
if (WiFi.RSSI(i) <= -100) {
quality = 0;
} else if (WiFi.RSSI(i) >= -50) {
quality = 100;
} else {
quality = 2 * (WiFi.RSSI(i) + 100);
}
if (i) json += ",";
json += "{";
json += "\"ssid\":\"" + WiFi.SSID(i) + "\"";
json += ",\"bssid\":\"" + WiFi.BSSIDstr(i) + "\"";
json += ",\"rssi\":" + String(WiFi.RSSI(i));
json += ",\"channel\":" + String(WiFi.channel(i));
json += ",\"secure\":" + String(WiFi.encryptionType(i));
json += ",\"quality\":"+ String(quality); // WiFi strength in percent
json += ",\"wico\":\"w" + String(int(round(map(quality, 0, 100, 1, 4)))) + "\""; // WiFi strength icon ("w1"-"w4")
json += ",\"pico\":\"" + String((WIFI_AUTH_OPEN == WiFi.encryptionType(i)) ? "" : "pw") + "\""; // auth icon ("p1" for secured)
json += "}";
}
WiFi.scanDelete();
if(WiFi.scanComplete() == -2) {
WiFi.scanNetworks(true, false, true, 120);
}
}
json += "]";
request->send(200, "application/json", json);
json = String();
}
void Web_Cyclic(void) {
webserverStart();
ws.cleanupClients();
}
// handle not found
void notFound(AsyncWebServerRequest *request) {
Log_Printf(LOGLEVEL_ERROR, "%s not found, redirect to startpage", request->url().c_str());
String html = "<!DOCTYPE html>Ooups - page \"" + request->url() + "\" not found (404)";
html += "<script>async function tryRedirect() {try {var url = \"/\";const response = await fetch(url);window.location.href = url;} catch (error) {console.log(error);setTimeout(tryRedirect, 2000);}}tryRedirect();</script>";
// for captive portal, send statuscode 200 & auto redirect to startpage
request->send(200, "text/html", html);
}
void webserverStart(void) {
if (!webserverStarted && (Wlan_IsConnected() || (WiFi.getMode() == WIFI_AP))) {
// attach AsyncWebSocket for Mgmt-Interface
ws.onEvent(onWebsocketEvent);
wServer.addHandler(&ws);
// attach AsyncEventSource
wServer.addHandler(&events);
// Default
wServer.on("/", HTTP_GET, [](AsyncWebServerRequest *request) {
AsyncWebServerResponse *response;
// const bool etag = request->hasHeader("if-None-Match") && request->getHeader("if-None-Match")->value().equals(gitRevShort);
const bool etag = false;
if (etag)
response = request->beginResponse(304);
else {
if (WiFi.getMode() == WIFI_STA) {
// serve management.html in station-mode
if (gFSystem.exists("/.html/index.htm"))
response = request->beginResponse(gFSystem, "/.html/index.htm", String(), false);
else {
response = request->beginResponse_P(200, "text/html", (const uint8_t *)management_BIN, sizeof(management_BIN));
response->addHeader("Content-Encoding", "gzip");
}
} else {
// serve accesspoint.html in AP-mode
response = request->beginResponse_P(200, "text/html", (const uint8_t *)accesspoint_BIN, sizeof(accesspoint_BIN));
response->addHeader("Content-Encoding", "gzip");
}
}
// response->addHeader("Cache-Control", "public, max-age=31536000, immutable");
// response->addHeader("ETag", gitRevShort); // use git revision as digest
request->send(response);
});
WWWData::registerRoutes(serveProgmemFiles);
// Log
wServer.on("/log", HTTP_GET, [](AsyncWebServerRequest *request) {
request->send(200, "text/plain; charset=utf-8", Log_GetRingBuffer());
System_UpdateActivityTimer();
});
// info
wServer.on("/info", HTTP_GET, handleGetInfo);
// NVS-backup-upload
wServer.on(
"/upload", HTTP_POST, [](AsyncWebServerRequest *request) {
request->send(200);
},
handleUpload);
// OTA-upload
wServer.on(
"/update", HTTP_POST, [](AsyncWebServerRequest *request) {
#ifdef BOARD_HAS_16MB_FLASH_AND_OTA_SUPPORT
if (Update.hasError()) {
request->send(500, "text/plain", Update.errorString());
} else {
request->send(200, "text/html", restartWebsite);
}
#else
request->send(500, "text/html", otaNotSupportedWebsite);
#endif
}, [](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) {
#ifndef BOARD_HAS_16MB_FLASH_AND_OTA_SUPPORT
Log_Println(otaNotSupported, LOGLEVEL_NOTICE);
return;
#endif
if (!index) {
// pause some tasks to get more free CPU time for the upload
vTaskSuspend(AudioTaskHandle);
Led_TaskPause();
Rfid_TaskPause();
Update.begin();
Log_Println(fwStart, LOGLEVEL_NOTICE);
}
Update.write(data, len);
Log_Print(".", LOGLEVEL_NOTICE, false);
if (final) {
Update.end(true);
// resume the paused tasks
Led_TaskResume();
vTaskResume(AudioTaskHandle);
Rfid_TaskResume();
Log_Println(fwEnd, LOGLEVEL_NOTICE);
if (Update.hasError()) {
Log_Println(Update.errorString(), LOGLEVEL_ERROR);
}
Serial.flush();
//ESP.restart(); // restart is done via webpage javascript
}
});
// ESP-restart
wServer.on("/restart", HTTP_POST, [](AsyncWebServerRequest *request) {
request->send_P(200, "text/html", restartWebsite);
System_Restart();
});
// ESP-shutdown
wServer.on("/shutdown", HTTP_POST, [](AsyncWebServerRequest *request) {
request->send(200, "text/html", shutdownWebsite);
System_RequestSleep();
});
#ifdef CONFIG_FREERTOS_USE_TRACE_FACILITY
// runtime task statistics
wServer.on("/stats", HTTP_GET, [](AsyncWebServerRequest *request){
AsyncResponseStream *response = request->beginResponseStream("text/html");
response->println("<!DOCTYPE html><html><head> <meta charset='utf-8'><title>ESPuino runtime stats</title>");
response->println("<meta http-equiv='refresh' content='2'>"); // refresh page every 2 seconds
response->println("</head><body>Tasklist:<div class='text'><pre>");
// show tasklist
char *pbuffer = (char *)calloc(2048, 1);
vTaskList(pbuffer);
response->println(pbuffer);
response->println("</pre></div><br><br>Runtime statistics:<div class='text'><pre>");
// show vTaskGetRunTimeStats()
vTaskGetRunTimeStats(pbuffer);
response->println(pbuffer);
response->println("</pre></div></body></html>");
free(pbuffer);
//send the response last
request->send(response);
});
#endif
// erase all RFID-assignments from NVS
wServer.on("/rfidnvserase", HTTP_POST, [](AsyncWebServerRequest *request) {
Log_Println(eraseRfidNvs, LOGLEVEL_NOTICE);
// make a backup first
Web_DumpNvsToSd("rfidTags", backupFile);
if (gPrefsRfid.clear()) {
request->send(200);
} else {
request->send(500);
}
System_UpdateActivityTimer();
});
// RFID
wServer.on("/rfid", HTTP_GET, handleGetRFIDRequest);
wServer.addHandler(new AsyncCallbackJsonWebHandler("/rfid", handlePostRFIDRequest));
wServer.addRewrite(new OneParamRewrite("/rfid/{id}", "/rfid?id={id}") );
wServer.on("/rfid", HTTP_DELETE, handleDeleteRFIDRequest);
// WiFi scan
wServer.on("/wifiscan", HTTP_GET, handleWiFiScanRequest);
// Fileexplorer (realtime)
wServer.on("/explorer", HTTP_GET, explorerHandleListRequest);
wServer.on(
"/explorer", HTTP_POST, [](AsyncWebServerRequest *request) {
request->send(200);
},
explorerHandleFileUpload);
wServer.on("/explorerdownload", HTTP_GET, explorerHandleDownloadRequest);
wServer.on("/explorer", HTTP_DELETE, explorerHandleDeleteRequest);
wServer.on("/explorer", HTTP_PUT, explorerHandleCreateRequest);
wServer.on("/explorer", HTTP_PATCH, explorerHandleRenameRequest);
wServer.on("/exploreraudio", HTTP_POST, explorerHandleAudioRequest);
wServer.on("/savedSSIDs", HTTP_GET, handleGetSavedSSIDs);
wServer.addHandler(new AsyncCallbackJsonWebHandler("/savedSSIDs", handlePostSavedSSIDs));
wServer.addRewrite(new OneParamRewrite("/savedSSIDs/{ssid}", "/savedSSIDs?ssid={ssid}") );
wServer.on("/savedSSIDs", HTTP_DELETE, handleDeleteSavedSSIDs);
wServer.on("/activeSSID", HTTP_GET, handleGetActiveSSID);
wServer.on("/wificonfig", HTTP_GET, handleGetWiFiConfig);
wServer.addHandler(new AsyncCallbackJsonWebHandler("/wificonfig", handlePostWiFiConfig));
// current cover image
wServer.on("/cover", HTTP_GET, handleCoverImageRequest);
// ESPuino logo
wServer.on("/logo", HTTP_GET, [](AsyncWebServerRequest *request) {
Log_Println("logo request", LOGLEVEL_DEBUG);
if (gFSystem.exists("/.html/logo.png")) {
request->send(gFSystem, "/.html/logo.png", "image/png");
return;
};
if (gFSystem.exists("/.html/logo.svg")) {
request->send(gFSystem, "/.html/logo.svg", "image/svg+xml");
return;
};
request->redirect("https://www.espuino.de/Espuino.webp");
});
// ESPuino favicon
wServer.on("/favicon.ico", HTTP_GET, [](AsyncWebServerRequest *request) {
if (gFSystem.exists("/.html/favicon.ico")) {
request->send(gFSystem, "/.html/favicon.png", "image/x-icon");
return;
};
request->redirect("https://espuino.de/espuino/favicon.ico");
});
// ESPuino settings
wServer.on("/settings", HTTP_GET, handleGetSettings);
wServer.addHandler(new AsyncCallbackJsonWebHandler("/settings", handlePostSettings));
// Init HallEffectSensor Value
#ifdef HALLEFFECT_SENSOR_ENABLE
wServer.on("/inithalleffectsensor", HTTP_GET, [](AsyncWebServerRequest *request) {
bool bres = gHallEffectSensor.saveActualFieldValue2NVS();
char buffer[128];
snprintf(buffer, sizeof(buffer), "WebRequest>HallEffectSensor FieldValue: %d => NVS, Status: %s", gHallEffectSensor.NullFieldValue(), bres ? "OK" : "ERROR");
Log_Println(buffer, LOGLEVEL_INFO);
request->send(200, "text/html", buffer);
});
#endif
wServer.onNotFound(notFound);
// allow cors for local debug (https://github.com/me-no-dev/ESPAsyncWebServer/issues/1080)
DefaultHeaders::Instance().addHeader("Access-Control-Allow-Headers", "Accept, Content-Type, Authorization");
DefaultHeaders::Instance().addHeader("Access-Control-Allow-Credentials", "true");
DefaultHeaders::Instance().addHeader("Access-Control-Allow-Origin", "*");
wServer.begin();
webserverStarted = true;
Log_Println(httpReady, LOGLEVEL_NOTICE);
// start a first WiFi scan (to get a WiFi list more quickly in webview)
WiFi.scanNetworks(true, false, true, 120);
}
}
unsigned long lastPongTimestamp;
// process JSON to settings
bool JSONToSettings(JsonObject doc) {
if (!doc) {
Log_Println("JSONToSettings: doc unassigned", LOGLEVEL_DEBUG);
return false;
}
if (doc.containsKey("general")) {
// general settings
if (gPrefsSettings.putUInt("initVolume", doc["general"]["initVolume"].as<uint8_t>()) == 0 ||
gPrefsSettings.putUInt("maxVolumeSp", doc["general"]["maxVolumeSp"].as<uint8_t>()) == 0 ||
gPrefsSettings.putUInt("maxVolumeHp", doc["general"]["maxVolumeHp"].as<uint8_t>()) == 0 ||
gPrefsSettings.putUInt("mInactiviyT", doc["general"]["sleepInactivity"].as<uint8_t>()) == 0 ) {
Log_Println("Failed to save general settings", LOGLEVEL_ERROR);
return false;
}
}
if (doc.containsKey("wifi")) {
// WiFi settings
static String hostName = doc["wifi"]["hostname"];
if (!Wlan_ValidateHostname(hostName)) {
Log_Println("Invalid hostname", LOGLEVEL_ERROR);
return false;
}
if (((!Wlan_SetHostname(hostName)) || gPrefsSettings.putBool("ScanWiFiOnStart", doc["wifi"]["scanOnStart"].as<bool>()) == 0)) {
Log_Println("Failed to save wifi settings", LOGLEVEL_ERROR);
return false;
}
}
if (doc.containsKey("led")) {
// Neopixel settings
if (gPrefsSettings.putUChar("iLedBrightness", doc["led"]["initBrightness"].as<uint8_t>()) == 0 ||
gPrefsSettings.putUChar("nLedBrightness", doc["led"]["nightBrightness"].as<uint8_t>()) == 0 ) {
Log_Println("Failed to save LED settings", LOGLEVEL_ERROR);
return false;
}
}
if (doc.containsKey("battery")) {
// Battery settings
if (gPrefsSettings.putFloat("wLowVoltage", doc["battery"]["warnLowVoltage"].as<float>()) == 0 ||
gPrefsSettings.putFloat("vIndicatorLow", doc["battery"]["indicatorLow"].as<float>()) == 0 ||
gPrefsSettings.putFloat("vIndicatorHigh", doc["battery"]["indicatorHi"].as<float>()) == 0 ||
gPrefsSettings.putUInt("vCheckIntv", doc["battery"]["voltageCheckInterval"].as<uint8_t>()) == 0 ) {
Log_Println("Failed to save battery settings", LOGLEVEL_ERROR);
return false;
}
Battery_Init();
}
if (doc.containsKey("ftp")) {
const char *_ftpUser = doc["ftp"]["username"];
const char *_ftpPwd = doc["ftp"]["password"];
gPrefsSettings.putString("ftpuser", (String)_ftpUser);
gPrefsSettings.putString("ftppassword", (String)_ftpPwd);
// Check if settings were written successfully
if (!(String(_ftpUser).equals(gPrefsSettings.getString("ftpuser", "-1")) ||
String(_ftpPwd).equals(gPrefsSettings.getString("ftppassword", "-1")))) {
Log_Println("Failed to save ftp settings", LOGLEVEL_ERROR);
return false;
}
} else if (doc.containsKey("ftpStatus")) {
uint8_t _ftpStart = doc["ftpStatus"]["start"].as<uint8_t>();
if (_ftpStart == 1) { // ifdef FTP_ENABLE is checked in Ftp_EnableServer()
Ftp_EnableServer();
}
}
if (doc.containsKey("mqtt")) {
uint8_t _mqttEnable = doc["mqtt"]["enable"].as<uint8_t>();
const char *_mqttClientId = doc["mqtt"]["clientID"];
const char *_mqttServer = doc["mqtt"]["server"];
const char *_mqttUser = doc["mqtt"]["username"];
const char *_mqttPwd = doc["mqtt"]["password"];
uint16_t _mqttPort = doc["mqtt"]["port"].as<uint16_t>();
gPrefsSettings.putUChar("enableMQTT", _mqttEnable);
gPrefsSettings.putString("mqttClientId", (String)_mqttClientId);
gPrefsSettings.putString("mqttServer", (String)_mqttServer);
gPrefsSettings.putString("mqttUser", (String)_mqttUser);
gPrefsSettings.putString("mqttPassword", (String)_mqttPwd);
gPrefsSettings.putUInt("mqttPort", _mqttPort);
if ((gPrefsSettings.getUChar("enableMQTT", 99) != _mqttEnable) ||
(!String(_mqttServer).equals(gPrefsSettings.getString("mqttServer", "-1")))) {
Log_Println("Failed to save mqtt settings", LOGLEVEL_ERROR);
return false;
}
}
if (doc.containsKey("bluetooth")) {
// bluetooth settings
const char *_btDeviceName = doc["bluetooth"]["deviceName"];
gPrefsSettings.putString("btDeviceName", (String)_btDeviceName);
const char *btPinCode = doc["bluetooth"]["pinCode"];
gPrefsSettings.putString("btPinCode", (String)btPinCode);
// Check if settings were written successfully
if (gPrefsSettings.getString("btDeviceName", "") != _btDeviceName ||
gPrefsSettings.getString("btPinCode", "") != btPinCode) {
Log_Println("Failed to save bluetooth settings", LOGLEVEL_ERROR);
return false;
}
} else if (doc.containsKey("rfidMod")) {
const char *_rfidIdModId = doc["rfidMod"]["rfidIdMod"];
uint8_t _modId = doc["rfidMod"]["modId"];
if (_modId <= 0) {
gPrefsRfid.remove(_rfidIdModId);
} else {
char rfidString[12];
snprintf(rfidString, sizeof(rfidString) / sizeof(rfidString[0]), "%s0%s0%s%u%s0", stringDelimiter, stringDelimiter, stringDelimiter, _modId, stringDelimiter);
gPrefsRfid.putString(_rfidIdModId, rfidString);
String s = gPrefsRfid.getString(_rfidIdModId, "-1");
if (s.compareTo(rfidString)) {
return false;
}
}
Web_DumpNvsToSd("rfidTags", backupFile); // Store backup-file every time when a new rfid-tag is programmed
} else if (doc.containsKey("rfidAssign")) {
const char *_rfidIdAssinId = doc["rfidAssign"]["rfidIdMusic"];
char _fileOrUrlAscii[MAX_FILEPATH_LENTGH];
convertFilenameToAscii(doc["rfidAssign"]["fileOrUrl"], _fileOrUrlAscii);
uint8_t _playMode = doc["rfidAssign"]["playMode"];
if (_playMode <= 0) {
Log_Println("rfidAssign: Invalid playmode", LOGLEVEL_ERROR);
return false;
}
char rfidString[275];
snprintf(rfidString, sizeof(rfidString) / sizeof(rfidString[0]), "%s%s%s0%s%u%s0", stringDelimiter, _fileOrUrlAscii, stringDelimiter, stringDelimiter, _playMode, stringDelimiter);
gPrefsRfid.putString(_rfidIdAssinId, rfidString);
#ifdef DONT_ACCEPT_SAME_RFID_TWICE_ENABLE
Rfid_ResetOldRfid(); // Set old rfid-id to crap in order to allow to re-apply a new assigned rfid-tag exactly once
#endif
String s = gPrefsRfid.getString(_rfidIdAssinId, "-1");
if (s.compareTo(rfidString)) {
return false;
}
Web_DumpNvsToSd("rfidTags", backupFile); // Store backup-file every time when a new rfid-tag is programmed
} else if (doc.containsKey("ping")) {
if ((millis() - lastPongTimestamp) > 1000u) {
// send pong (keep-alive heartbeat), check for excessive calls
lastPongTimestamp = millis();
Web_SendWebsocketData(0, 20);
}
return false;
} else if (doc.containsKey("controls")) {
if (doc["controls"].containsKey("set_volume")) {
uint8_t new_vol = doc["controls"]["set_volume"].as<uint8_t>();
AudioPlayer_VolumeToQueueSender(new_vol, true);
} if (doc["controls"].containsKey("action")) {
uint8_t cmd = doc["controls"]["action"].as<uint8_t>();
Cmd_Action(cmd);
}
} else if (doc.containsKey("trackinfo")) {
Web_SendWebsocketData(0, 30);
} else if (doc.containsKey("coverimg")) {
Web_SendWebsocketData(0, 40);
} else if (doc.containsKey("volume")) {
Web_SendWebsocketData(0, 50);
} else if (doc.containsKey("settings")) {
Web_SendWebsocketData(0, 60);
} else if (doc.containsKey("ssids")) {
Web_SendWebsocketData(0, 70);
}
return true;
}
// process settings to JSON object
static void settingsToJSON(JsonObject obj, String section) {
if ((section == "") || (section == "current")) {
// current values
JsonObject curObj = obj.createNestedObject("current");
curObj["volume"].set(AudioPlayer_GetCurrentVolume());
curObj["rfidTagId"] = String(gCurrentRfidTagId);
}
if ((section == "") || (section == "general")) {
// general settings
JsonObject generalObj = obj.createNestedObject("general");
generalObj["initVolume"].set(gPrefsSettings.getUInt("initVolume", 0));
generalObj["maxVolumeSp"].set(gPrefsSettings.getUInt("maxVolumeSp", 0));
generalObj["maxVolumeHp"].set(gPrefsSettings.getUInt("maxVolumeHp", 0));
generalObj["sleepInactivity"].set(gPrefsSettings.getUInt("mInactiviyT", 0));
}
if ((section == "") || (section == "wifi")) {
// WiFi settings
JsonObject wifiObj = obj.createNestedObject("wifi");
wifiObj["hostname"] = Wlan_GetHostname();
wifiObj["scanOnStart"].set(gPrefsSettings.getBool("ScanWiFiOnStart", false));
}
if (section == "ssids") {
// saved SSID's
JsonObject ssidsObj = obj.createNestedObject("ssids");
static String ssids[10];
JsonArray ssidArr = ssidsObj.createNestedArray("savedSSIDs");
size_t len = Wlan_GetSSIDs(ssids, 10);
if (len > 0) {
for (int i = 0; i < len; i++) {
ssidArr.add(ssids[i]);
}
}
// active SSID
if (Wlan_IsConnected()) {
ssidsObj["active"] = Wlan_GetCurrentSSID();
}
}
#ifdef NEOPIXEL_ENABLE
if ((section == "") || (section == "led")) {
// LED settings
JsonObject ledObj = obj.createNestedObject("led");
ledObj["initBrightness"].set(gPrefsSettings.getUChar("iLedBrightness", 0));
ledObj["nightBrightness"].set(gPrefsSettings.getUChar("nLedBrightness", 0));
}
#endif
#ifdef MEASURE_BATTERY_VOLTAGE
if ((section == "") || (section == "battery")) {
// battery settings
JsonObject batteryObj = obj.createNestedObject("battery");
batteryObj["warnLowVoltage"].set(gPrefsSettings.getFloat("wLowVoltage", s_warningLowVoltage));
batteryObj["indicatorLow"].set(gPrefsSettings.getFloat("vIndicatorLow", s_voltageIndicatorLow));
batteryObj["indicatorHi"].set(gPrefsSettings.getFloat("vIndicatorHigh", s_voltageIndicatorHigh));
batteryObj["voltageCheckInterval"].set(gPrefsSettings.getUInt("vCheckIntv", s_batteryCheckInterval));
}
#endif
if (section == "defaults") {
// default factory settings
JsonObject defaultsObj = obj.createNestedObject("defaults");
defaultsObj["initVolume"].set(3u); // AUDIOPLAYER_VOLUME_INIT
defaultsObj["maxVolumeSp"].set(21u); // AUDIOPLAYER_VOLUME_MAX
defaultsObj["maxVolumeHp"].set(18u); // gPrefsSettings.getUInt("maxVolumeHp", 0));
defaultsObj["sleepInactivity"].set(10u); // System_MaxInactivityTime
#ifdef NEOPIXEL_ENABLE
defaultsObj["initBrightness"].set(16u); // LED_INITIAL_BRIGHTNESS
defaultsObj["nightBrightness"].set(2u); // LED_INITIAL_NIGHT_BRIGHTNESS
#endif
#ifdef MEASURE_BATTERY_VOLTAGE
defaultsObj["warnLowVoltage"].set(s_warningLowVoltage);
defaultsObj["indicatorLow"].set(s_voltageIndicatorLow);
defaultsObj["indicatorHi"].set(s_voltageIndicatorHigh);
defaultsObj["voltageCheckInterval"].set(s_batteryCheckInterval);
#endif
}
// FTP
#ifdef FTP_ENABLE
if ((section == "") || (section == "ftp")) {
JsonObject ftpObj = obj.createNestedObject("ftp");
ftpObj["username"] = gPrefsSettings.getString("ftpuser", "-1");
ftpObj["password"] = gPrefsSettings.getString("ftppassword", "-1");
ftpObj["maxUserLength"].set(ftpUserLength - 1);
ftpObj["maxPwdLength"].set(ftpUserLength - 1);
}
#endif
// MQTT
#ifdef MQTT_ENABLE
if ((section == "") || (section == "mqtt")) {
JsonObject mqttObj = obj.createNestedObject("mqtt");
mqttObj["enable"].set(Mqtt_IsEnabled());
mqttObj["clientID"] = gPrefsSettings.getString("mqttClientId", "-1");
mqttObj["server"] = gPrefsSettings.getString("mqttServer", "-1");
mqttObj["port"].set(gPrefsSettings.getUInt("mqttPort", 0));
mqttObj["username"] = gPrefsSettings.getString("mqttUser", "-1");
mqttObj["password"] = gPrefsSettings.getString("mqttPassword", "-1");
mqttObj["maxUserLength"].set(mqttUserLength - 1);
mqttObj["maxPwdLength"].set(mqttPasswordLength - 1);
mqttObj["maxClientIdLength"].set(mqttClientIdLength - 1);
mqttObj["maxServerLength"].set(mqttServerLength - 1);
}
#endif
// Bluetooth
#ifdef BLUETOOTH_ENABLE
if ((section == "") || (section == "bluetooth")) {
JsonObject btObj = obj.createNestedObject("bluetooth");
if (gPrefsSettings.isKey("btDeviceName")) {
btObj["deviceName"] = gPrefsSettings.getString("btDeviceName", "");
} else {
btObj["deviceName"] = "";
}
if (gPrefsSettings.isKey("btPinCode")) {
btObj["pinCode"] = gPrefsSettings.getString("btPinCode", "");
} else {
btObj["pinCode"] = "";
}
}
#endif
}
// handle get info
void handleGetInfo(AsyncWebServerRequest *request) {
// param to get a single info section
String section = "";
if (request->hasParam("section")) {
section = request->getParam("section")->value();
}
#ifdef BOARD_HAS_PSRAM
SpiRamJsonDocument doc(512);
#else
StaticJsonDocument<512> doc;
#endif
JsonObject infoObj = doc.createNestedObject("info");
// software
if ((section == "") || (section == "software")) {
JsonObject softwareObj = infoObj.createNestedObject("software");
softwareObj["version"] = (String) softwareRevision;
softwareObj["git"] = (String) gitRevision;
softwareObj["arduino"] = String(ESP_ARDUINO_VERSION_MAJOR) + "." + String(ESP_ARDUINO_VERSION_MINOR) + "." + String(ESP_ARDUINO_VERSION_PATCH);
softwareObj["idf"] = String(ESP.getSdkVersion());
}
// hardware
if ((section == "") || (section == "hardware")) {
JsonObject hardwareObj = infoObj.createNestedObject("hardware");
hardwareObj["model"] = String(ESP.getChipModel());
hardwareObj["revision"] = ESP.getChipRevision();
hardwareObj["freq"] = ESP.getCpuFreqMHz();
}
// memory
if ((section == "") || (section == "memory")) {
JsonObject memoryObj = infoObj.createNestedObject("memory");
memoryObj["freeHeap"] = ESP.getFreeHeap();
memoryObj["largestFreeBlock"] = (uint32_t)heap_caps_get_largest_free_block(MALLOC_CAP_8BIT);
if (psramInit()) {
memoryObj["freePSRam"] = ESP.getFreePsram();
}
}
// wifi
if ((section == "") || (section == "wifi")) {
JsonObject wifiObj = infoObj.createNestedObject("wifi");
wifiObj["ip"] = Wlan_GetIpAddress();
wifiObj["rssi"] = (int8_t)Wlan_GetRssi();
}
// audio
if ((section == "") || (section == "audio")) {
JsonObject audioObj = infoObj.createNestedObject("audio");
audioObj["playtimeTotal"] = AudioPlayer_GetPlayTimeAllTime();
audioObj["playtimeSinceStart"] = AudioPlayer_GetPlayTimeSinceStart();
audioObj["firstStart"] = gPrefsSettings.getULong("firstStart", 0);
}
#ifdef BATTERY_MEASURE_ENABLE
// battery
if ((section == "") || (section == "battery")) {
JsonObject batteryObj = infoObj.createNestedObject("battery");
batteryObj["currVoltage"] = Battery_GetVoltage();
batteryObj["chargeLevel"] = Battery_EstimateLevel() * 100;
}
#endif
#ifdef HALLEFFECT_SENSOR_ENABLE
if ((section == "") || (section == "hallsensor")) {
// hallsensor
JsonObject hallObj = infoObj.createNestedObject("hallsensor");
uint16_t sva = gHallEffectSensor.readSensorValueAverage(true);
int diff = sva-gHallEffectSensor.NullFieldValue();
hallObj["nullFieldValue"] =gHallEffectSensor.NullFieldValue();
hallObj["actual"] = sva;
hallObj["diff"] = diff;
hallObj["lastWaitState"] = gHallEffectSensor.LastWaitForState();
hallObj["lastWaitMS"] = gHallEffectSensor.LastWaitForStateMS();
}
#endif
String serializedJsonString;
serializeJson(infoObj, serializedJsonString);
request->send(200, "application/json; charset=utf-8", serializedJsonString);
System_UpdateActivityTimer();
}
// handle get settings
void handleGetSettings(AsyncWebServerRequest *request) {
// param to get a single settings section
String section = "";
if (request->hasParam("section")) {
section = request->getParam("section")->value();
}
#ifdef BOARD_HAS_PSRAM
SpiRamJsonDocument doc(8192);
#else
StaticJsonDocument<8192> doc;
#endif
JsonObject settingsObj = doc.createNestedObject("settings");
settingsToJSON(settingsObj, section);
String serializedJsonString;
serializeJson(settingsObj, serializedJsonString);
request->send(200, "application/json; charset=utf-8", serializedJsonString);
}
// handle post settings
void handlePostSettings(AsyncWebServerRequest *request, JsonVariant &json) {
const JsonObject& jsonObj = json.as<JsonObject>();
bool succ = JSONToSettings(jsonObj);
if (succ) {
request->send(200);
} else {
request->send(500, "text/plain; charset=utf-8", "error saving settings");
}
}
// Takes inputs from webgui, parses JSON and saves values in NVS
// If operation was successful (NVS-write is verified) true is returned
bool processJsonRequest(char *_serialJson) {
if (!_serialJson) {
return false;
}
#ifdef BOARD_HAS_PSRAM
SpiRamJsonDocument doc(1000);
#else
StaticJsonDocument<1000> doc;
#endif
DeserializationError error = deserializeJson(doc, _serialJson);
if (error) {
Log_Printf(LOGLEVEL_ERROR, jsonErrorMsg, error.c_str());
return false;
}
JsonObject obj = doc.as<JsonObject>();
return JSONToSettings(obj);
}
// Sends JSON-answers via websocket
void Web_SendWebsocketData(uint32_t client, uint8_t code) {
if (!webserverStarted)
return;
char *jBuf = (char *) x_calloc(1024, sizeof(char));
StaticJsonDocument<1024> doc;
JsonObject object = doc.to<JsonObject>();
if (code == 1) {
object["status"] = "ok";
} else if (code == 2) {
object["status"] = "error";
} else if (code == 10) {
object["rfidId"] = gCurrentRfidTagId;
} else if (code == 20) {
object["pong"] = "pong";
object["rssi"] = Wlan_GetRssi();
// todo: battery percent + loading status +++
//object["battery"] = Battery_GetVoltage();
} else if (code == 30) {
JsonObject entry = object.createNestedObject("trackinfo");
entry["pausePlay"] = gPlayProperties.pausePlay;
entry["currentTrackNumber"] = gPlayProperties.currentTrackNumber + 1;
entry["numberOfTracks"] = gPlayProperties.numberOfTracks;
entry["volume"] = AudioPlayer_GetCurrentVolume();
entry["name"] = gPlayProperties.title;
} else if (code == 40) {
object["coverimg"] = "coverimg";
} else if (code == 50) {
object["volume"] = AudioPlayer_GetCurrentVolume();
} else if (code == 60) {
JsonObject entry = object.createNestedObject("settings");
settingsToJSON(entry, "");
} else if (code == 70) {
JsonObject entry = object.createNestedObject("settings");
settingsToJSON(entry, "ssids");