forked from LowPowerLab/RaspberryPi-Gateway
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gateway.js
1269 lines (1146 loc) · 56.7 KB
/
gateway.js
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
// **********************************************************************************
// Websocket server backend for the Moteino IoT Gateway
// Hardware and software stack details: http://lowpowerlab.com/gateway
// This is a work in progress and is released without any warranties expressed or implied.
// See license.txt for license and limitations of use of this software.
// **********************************************************************************
// Based on Node.js, and following node packages:
// socket.io, node-serialport, neDB, nodemailer, console-stamp
// **********************************************************************************
// BEFORE THE FIRST USE:
// Adjust settings in settings.json5 and read the rest of this readme.
// **********************************************************************************
// NeDB is Node Embedded Database - a persistent database for Node.js, with no dependency
// Specs and documentation at: https://github.com/louischatriot/nedb
//
// Under the hood, NeDB's persistence uses an append-only format, meaning that all updates
// and deletes actually result in lines added at the end of the datafile. The reason for
// this is that disk space is very cheap and appends are much faster than rewrites since
// they don't do a seek. The database is automatically compacted (i.e. put back in the
// one-line-per-document format) everytime your application restarts.
//
// This script is configured to compact the database every 24 hours since time of start.
// ********************************************************************************************
// Copyright Felix Rusu, Low Power Lab LLC (2018), http://lowpowerlab.com/contact
// ********************************************************************************************
// IMPORTANT details about NeDB:
// _id field is special - if not used it is automatically added and used as unique index
// - we can set that field when inserting to use it as an automatic unique index for fast lookups of nodes (by node Id)
// ********************************************************************************************
// Note: In NodeJS modules are loaded synchronously and processed in the order they occur
// ********************************************************************************************
var nconf = require('nconf'); //https://github.com/indexzero/nconf
var JSON5 = require('json5'); //https://github.com/aseemk/json5
var path = require('path');
var dbDir = 'data/db';
var packageJson = require('./package.json')
var coreMetricsFilePath = './metrics/core.js';
nconf.argv().file({ file: './settings.json5', format: JSON5 });
global.settings = nconf.get('settings');
var dbLog = require('./logUtil.js');
io = require('socket.io')().listen(settings.general.socketPort.value) //usage in 2.3.0: io = require('socket.io').listen(settings.general.socketPort.value);
var serialport = require("serialport"); //https://github.com/node-serialport/node-serialport
var Datastore = require('nedb'); //https://github.com/louischatriot/nedb
var nodemailer = require('nodemailer'); //https://github.com/andris9/Nodemailer
var http = require('http');
var url = require('url');
db = new Datastore({ filename: path.join(__dirname, dbDir, settings.database.name.value), autoload: true }); //used to keep all node/metric data
var dbCompacted = Date.now();
var fs = require('fs');
var gatewayUptime='';
var gatewayFrequency='';
global.port=undefined;
global.parser=undefined;
var unmatchedDataDB = null;
if (settings.database.nonMatchesName.value)
unmatchedDataDB = new Datastore({ filename: path.join(__dirname, dbDir, settings.database.nonMatchesName.value), autoload: true });
require("console-stamp")(console, settings.general.consoleLogDateFormat.value); //timestamp logs - https://github.com/starak/node-console-stamp
//HTTP ENDPOINT - accept HTTP: data from the internet/LAN
http.createServer(httpEndPointHandler).listen(8081);
console.info('*********************************************************************');
console.info('************************* GATEWAY APP START *************************');
console.info('*********************************************************************');
serialport.list().then(ports => { ports.forEach(function(port) { console.info(`Available serial port: ${JSON.stringify(port)}`) }); });
var openPort = (function f(reopen) {
if (reopen && port.isOpen) port.close();
port = new serialport(settings.serial.port.value, {baudRate : settings.serial.baud.value});
parser = port.pipe(new serialport.parsers.Readline()); //new serialport.parsers.Readline(); //port.pipe(parser);
parser.on('data', function(data) { processSerialData(data.replace(/\0/g, '')); }); //replace nulls in received string
port.on('error', function serialErrorHandler(error) {
msg = 'node-serialport error:' + error.message;
console.error(msg);
io.sockets.emit('LOG', msg);
});
port.on('close', function serialCloseHandler(error) {
if (error) {
//Give user a sane error message and exit. Future: send message to UI & retry reopening
console.error(error.message);
//process.exit(1);
}
});
return f;
})();
global.caseInsensitiveSorter = function (a, b) {return a.toLowerCase().localeCompare(b.toLowerCase())};
String.prototype.replaceNewlines = function () { return this.replace(/(?:\r\n|\r|\n)/g, '\\n') };
var merge = require('merge');
global.loadMetricsFile = function(file, globalizeFunctions, fatal) {
if (fs.lstatSync(file).isFile() && file.match(/\.js$/) !== null) {
console.info(`LOADING METRICS MODULE [${file}]`);
try {
var tmp = require(file);
if (!global.metricsDef) global.metricsDef = {};
metricsDef.metrics = merge(false, metricsDef.metrics, tmp.metrics);
metricsDef.motes = merge(false, metricsDef.motes, tmp.motes);
metricsDef.events = merge(false, metricsDef.events, tmp.events);
if (globalizeFunctions) {
Object.getOwnPropertyNames(tmp).forEach(function(variable){
let type = typeof tmp[variable];
if (['function','number','string'].indexOf(type)>-1) {
console.info(`|- GLOBALIZING ${variable}${type=='function'?'()':''}${global[variable]!=undefined?' (WARNING:OVERRIDING PREVIOUS VALUE!)':''}`);
global[variable] = tmp[variable];
}
});
}
delete tmp.metrics;
delete tmp.motes;
delete tmp.events;
metricsDef = merge(false, metricsDef, tmp); //merge anything else (properties, variables, objects, functions)
} catch (ex) {
console.error(`FAIL LOADING METRICS MODULE [${file}]: ${ex.message}\n${ex.stack}`);
if (fatal) throw ex;
}
}
}
//LOAD NODE/METRICS DEFINITIONS:
// - First load main core.js definitions (metrics, motes, events etc)
loadMetricsFile(coreMetricsFilePath, true, true); //import core metrics file and globalize its objects & functions
// - Then load other metrics which can override core metrics
try {
fs.readdirSync(__dirname + '/metrics').sort(caseInsensitiveSorter).forEach(function(file) {
var subdirs = [];
if (fs.lstatSync(__dirname + '/metrics/' + file).isDirectory()) //check 1 level subdirs only
subdirs.push(__dirname + '/metrics/' + file);
else if (file != coreMetricsFilePath.substring(coreMetricsFilePath.lastIndexOf("/") + 1)) { //skip core.js, already loaded
loadMetricsFile(__dirname + '/metrics/'+file, true);
}
subdirs.forEach(function(subdir){
fs.readdirSync(__dirname + '/metrics/'+file).sort(caseInsensitiveSorter).forEach(function(subdirFile) {
loadMetricsFile(__dirname + '/metrics/'+file+'/'+subdirFile, true);
});
});
});
}
catch (ex) {
console.error('FAIL ACCESSING METRICS MODULE: '+ ex.message);
}
db.persistence.setAutocompactionInterval(settings.database.compactDBInterval.value); //compact the database every 24hrs
var transporter = nodemailer.createTransport({
service: settings.credentials.emailservice.value, //"gmail" is preconfigured by nodemailer, but you can setup any other email client supported by nodemailer
auth: {
user: settings.credentials.email.value,
pass: settings.credentials.emailpass.value,
}
});
global.sendEmail = function(SUBJECT, BODY, ATTACHMENTS) {
var mailOptions = {
from: 'Moteino Gateway <gateway@moteino.com>',
to: settings.credentials.emailAlertsTo.value, // list of receivers, comma separated
subject: SUBJECT,
text: BODY,
attachments: ATTACHMENTS
//html: '<b>Hello world ?</b>' // html body
};
transporter.sendMail(mailOptions, function(error, info) {
if(error) console.error('SENDEMAIL ERROR: ' + error);
else console.log('SENDEMAIL SUCCESS: ' + info.response);
});
}
global.sendSMS = function(SUBJECT, BODY) {
var mailOptions = {
from: 'Gateway <gateway@moteino.com>',
to: settings.credentials.smsAlertsTo.value, //your mobile carrier should have an email address that will generate a SMS to your phone
subject: SUBJECT,
text: BODY
};
transporter.sendMail(mailOptions, function(error, info) {
if(error) console.error('SENDSMS error: ' + error);
else console.log('SENDSMS SUCCESS: ' + info.response);
});
}
global.sendMessageToNode = function(node) {
if (isValidNodeId(node.nodeId) && node.action)
{
if (isNumeric(node.nodeId)) { //numeric ID - send to serial port (RF network)
//console.log('sendMessageToNode(): ' + JSON.stringify(node));
sendMessageToGateway(node.nodeId + ':' + node.action);
}
else if (isValidIP()) //IP address, send via HTTP
console.warning('sendMessageToNode() FAIL: http sending not implemented yet. Request: ' + JSON.stringify(node));
}
else if (node.action)
{
//console.log('sendMessageToNode()-else: ' + JSON.stringify(node));
sendMessageToGateway(node.action);
}
else console.error(`sendMessageToNode() FAIL: invalid nodeId or action: node=${JSON.stringify(node)}`);
}
global.sendMessageToGateway = function(msg) {
//console.log('sendMessageToGateway: ' + msg.replaceNewlines());
port.write(msg + '\n', function (err) {
if (err) return console.error('port.write error: ', err.message)
port.drain();
});
}
global.handleNodeEvents = function(node) {
if (node.events)
{
for (var key in node.events)
{
try {
if (node.events[key] && node.events[key].enabled)
{
var evt = metricsDef.events[key];
if (evt.serverExecute!=undefined)
try {
evt.serverExecute(node);
}
catch(ex) {console.warn(`Event ${key} execution failed: ${ex.message}`);}
}
} catch(ex) {console.warn(`-------> EXCEPTION: nodeId:${node._id} key:${key} JSON:${JSON.stringify(node)}`); throw ex;}
}
}
}
global.getGraphData = function(nodeId, metricKey, start, end, exportMode) {
var sts = Math.floor(start / 1000); //get timestamp in whole seconds
var ets = Math.floor(end / 1000); //get timestamp in whole seconds
var logfile = path.join(__dirname, dbDir, dbLog.getLogName(nodeId,metricKey));
var graphData = dbLog.getData(logfile, sts, ets, exportMode ? 100000 : settings.general.graphMaxPoints.value); //100k points when exporting, more points is really pointless
var graphOptions={};
for(var k in metricsDef.metrics)
{
if (metricsDef.metrics[k].name == metricKey)
{
if (metricsDef.metrics[k].graphOptions != undefined)
graphOptions = metricsDef.metrics[k].graphOptions;
break;
}
}
graphOptions.metricName=metricKey;
return { graphData:graphData, options : graphOptions };
}
global.getNodeIcons = function(dir, files_, steps){
files_ = files_ || [];
dir = dir || __dirname + '/www/images';
steps = steps || 0;
var files = fs.readdirSync(dir);
for (var i in files){
var name = dir + '/' + files[i];
if (fs.statSync(name).isDirectory() && steps==0) //recurse 1 level only
getNodeIcons(name, files_, steps+1);
else if (files[i].match(/^icon_.+\.(bmp|png|jpg|jpeg|ico)$/ig)) //images only
files_.push(name.replace(__dirname+'/www/images/',''));
}
return files_;
}
//authorize handshake - make sure the request is proxied from localhost, not from the outside world
//if you comment out this section, you will be able to hit this socket directly at the port it's running at, from anywhere!
//this was tested on Socket.IO v1.2.1 and will not work on older versions
io.use(function(socket, next) {
var handshakeData = socket.request.connection;
console.info(`AUTHORIZING CONNECTION FROM ${handshakeData.remoteAddress}:${handshakeData.remotePort}`);
if (handshakeData.remoteAddress == "localhost" || handshakeData.remoteAddress == "127.0.0.1" || handshakeData.remoteAddress == "::1" || handshakeData.remoteAddress == "::ffff:127.0.0.1")
{
next();
return;
}
else
{
var msg = 'REJECTED IDENTITY [' + handshakeData.remoteAddress + '], not coming from localhost';
console.error(msg);
next(new Error(msg));
}
});
function broadcastServerInfo(socket) {
infoObj = {
uptime:(Date.now() - process.uptime()*1000),
gatewayUptime:(isNumeric(gatewayUptime) ? gatewayUptime : 'unknown'),
gatewayFrequency:(isNumeric(gatewayFrequency) ? gatewayFrequency : 'unknown'),
version: packageJson.version,
nodeVersion: process.version,
serverMillisSinceEpoch: Date.now(),
};
if (socket)
socket.emit('SERVERINFO', infoObj);
else
io.sockets.emit('SERVERINFO', infoObj);
}
io.sockets.on('connection', function (socket) {
var address = socket.handshake.headers['x-forwarded-for'] || socket.request.connection.remoteAddress;
//var port = socket.request.connection.remotePort;
console.info("NEW CONNECTION FROM " + address /*+ ":" + port*/);
socket.emit('METRICSDEF', metricsDef);
socket.emit('SETTINGSDEF', settings);
broadcastServerInfo(socket);
socket.emit('DBCOMPACTED', dbCompacted);
socket.emit('NODEICONS', getNodeIcons());
//pull all nodes from the database and send them to client
db.find({ _id : { $exists: true } }, function (err, entries) {
socket.emit('UPDATENODES', sortNodes(entries));
});
socket.on('COMPACTDB', function () {
console.log('**** DB COMPACTION REQUESTED');
db.persistence.compactDatafile();
});
db.on('compaction.done', function(){
dbCompacted = Date.now();
socket.emit('DBCOMPACTED', dbCompacted);
console.log('**** DB COMPACTION DONE');
});
socket.on('REFRESHICONS', function () {
io.sockets.emit('NODEICONS', getNodeIcons());
});
socket.on('UPDATENODELISTORDER', function (newOrder) {
db.findOne({_id:'NODELISTORDER'}, function (err, doc) {
var entry = {_id:'NODELISTORDER', order:newOrder};
if (doc == null)
db.insert(entry);
else
db.update({ _id: 'NODELISTORDER' }, { $set : entry});
io.sockets.emit('NODELISTREORDER', newOrder);
});
});
socket.on('UPDATENODESETTINGS', function (node) {
db.find({ _id : node._id }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
dbNode.type = node.type||undefined;
dbNode.label = node.label||undefined;
dbNode.descr = node.descr||undefined;
dbNode.icon = node.icon||undefined;
dbNode.settings = node.settings||undefined;
dbNode.hidden = (node.hidden == 1 ? 1 : undefined);
db.update({ _id: dbNode._id }, { $set : dbNode}, {}, function (err, numReplaced) { /*console.log('UPDATENODESETTINGS records replaced:' + numReplaced);*/ });
socket.broadcast.emit('UPDATENODE', dbNode); //sent changes to all clients except sender socket
}
});
});
socket.on('UPDATEMETRICSETTINGS', function (nodeId, metricKey, metric) {
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
dbNode.metrics[metricKey].label = metric.label;
dbNode.metrics[metricKey].pin = (metric.pin==1) ? Date.now() : metric.pin;
dbNode.metrics[metricKey].graph = metric.graph;
db.update({ _id: dbNode._id }, { $set : dbNode}, {}, function (err, numReplaced) { /*console.log('UPDATEMETRICSETTINGS records replaced:' + numReplaced);*/ });
io.sockets.emit('UPDATENODE', dbNode); //post it back to all clients to confirm UI changes
}
});
});
socket.on('EDITNODEEVENT', function (nodeId, eventKey, enabled, remove) {
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
//cross check key to ensure it exists, then add it to the node events collection and persist to DB
for(var key in metricsDef.events)
if (eventKey == key)
{
if (!dbNode.events) dbNode.events = {};
if (!remove)
dbNode.events[eventKey] = { enabled: (enabled ? 1 : 0) };
else
dbNode.events[eventKey] = undefined;
scheduled = false;
if (!remove && metricsDef.events[eventKey] && metricsDef.events[eventKey].scheduledExecute)
{
if (enabled && !remove)
{
schedule(dbNode, eventKey);
scheduled = true;
}
else //either disabled or removed
{
for(var s in scheduledEvents)
{
if (scheduledEvents[s].nodeId == nodeId && scheduledEvents[s].eventKey == eventKey)
{
console.log(`**** REMOVING SCHEDULED EVENT - nodeId:${nodeId} event:${eventKey}}`);
clearTimeout(scheduledEvents[s].timer);
scheduledEvents.splice(scheduledEvents.indexOf(scheduledEvents[s]), 1)
dbNode.events[eventKey].executeDateTime=undefined;
}
}
}
}
if (!scheduled)
{
db.update({ _id: dbNode._id }, { $set : dbNode}, {}, function (err, numReplaced) { /*console.log('UPDATEMETRICSETTINGS records replaced:' + numReplaced);*/ });
io.sockets.emit('UPDATENODE', dbNode); //post it back to all clients to confirm UI changes
}
return;
}
}
});
});
socket.on('ADDNODEGRAPH', function (nodeId, selectedMetrics) {
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
var newGraph = [];
if (!dbNode.multiGraphs) dbNode.multiGraphs = []; //an array of metric-key arrays eg. [['Temp','RSSI'], ['Temp', 'Humidity', 'Voltage'], ...]
for(var arrayKey in selectedMetrics)
{
var metricKey = selectedMetrics[arrayKey];
if (Object.keys(dbNode.metrics).includes(metricKey)) //verify node metrics contains selected metric
{
newGraph.push(metricKey);
//console.log(' ************** ADDNODEGRAPH REQUEST: ' + nodeId + ' - ' + dbNode.metrics[selectedMetrics[key]].label);
}
}
dbNode.multiGraphs.push(newGraph);
db.update({ _id: dbNode._id }, { $set : dbNode}, {}, function (err, numReplaced) { /*console.log('UPDATEMETRICSETTINGS records replaced:' + numReplaced);*/ });
io.sockets.emit('UPDATENODE', dbNode); //post it back to all clients to confirm UI changes
}
});
});
socket.on('DELETENODEGRAPH', function (nodeId) {
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
dbNode.multiGraphs = undefined;
db.update({ _id: dbNode._id }, { $set : dbNode}, {}, function (err, numReplaced) { /*console.log('UPDATEMETRICSETTINGS records replaced:' + numReplaced);*/ });
io.sockets.emit('UPDATENODE', dbNode); //post it back to all clients to confirm UI changes
}
});
});
socket.on('DELETENODE', function (nodeId) {
//delete all node-metric log files
if (settings.general.keepMetricLogsOnDelete.value != 'true')
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
if (dbNode.metrics) {
Object.keys(dbNode.metrics).forEach(function(mKey,index) { //syncronous/blocking call
if (dbNode.metrics[mKey].graph == 1)
dbLog.removeMetricLog(path.join(__dirname, dbDir, dbLog.getLogName(dbNode._id, mKey)));
});
}
}
});
//delete the node from the DB
db.remove({ _id : nodeId }, function (err, removedCount) {
console.log('DELETED entries: ' + removedCount);
//pull all nodes from the database and send them to client
db.find({ _id : { $exists: true } }, function (err, entries) {
io.sockets.emit('UPDATENODES', sortNodes(entries));
});
});
//remove scheduled events associated with the deleted node
for(var s in scheduledEvents)
if (scheduledEvents[s].nodeId == nodeId)
{
console.log(`**** REMOVING SCHEDULED EVENT FOR DELETED NODE - NodeId:${nodeId} event:${scheduledEvents[s].eventKey}`);
clearTimeout(scheduledEvents[s].timer);
scheduledEvents.splice(scheduledEvents.indexOf(scheduledEvents[s]), 1);
}
});
socket.on('DELETENODEMETRIC', function (nodeId, metricKey) {
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
delete(dbNode.metrics[metricKey]);
db.update({ _id: dbNode._id }, { $set : dbNode}, {}, function (err, numReplaced) { console.info('DELETENODEMETRIC DB-Replaced:' + numReplaced); });
if (settings.general.keepMetricLogsOnDelete.value != 'true')
dbLog.removeMetricLog(path.join(__dirname, dbDir, dbLog.getLogName(dbNode._id, metricKey)));
io.sockets.emit('UPDATENODE', dbNode); //post it back to all clients to confirm UI changes
}
});
});
socket.on('DELETENODEREQUEST', function (nodeId, requestKey) {
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
reqName = dbNode.requests[requestKey].name;
reqValue = dbNode.requests[requestKey].value;
sendMessageToGateway(dbNode._id+':VOID:'+reqName+(reqValue?':'+reqValue:'')); //remove pending request from gateway's REQUEST queue
delete(dbNode.requests[requestKey]);
db.update({ _id: dbNode._id }, { $set : dbNode}, {}, function (err, numReplaced) { console.info('DELETENODEREQUEST DB-Replaced:' + numReplaced); });
io.sockets.emit('UPDATENODE', dbNode); //post it back to all clients to confirm UI changes
}
});
});
socket.on('DELETEMETRICDATA', function (nodeId, metricKey, start, end) {
var sts = Math.floor(start / 1000); //get timestamp in whole seconds
var ets = Math.floor(end / 1000); //get timestamp in whole seconds
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
var logfile = path.join(__dirname, dbDir, dbLog.getLogName(dbNode._id, metricKey));
var count = dbLog.deleteData(logfile, sts, ets);
console.info('DELETEMETRICDATA DB-Removed points:' + count);
//if (settings.general.keepMetricLogsOnDelete.value != 'true')
socket.emit('DELETEMETRICDATA_OK', count); //post it back to requesting client only
}
});
});
socket.on('EDITMETRICDATA', function (nodeId, metricKey, start, end, newValue) {
var sts = Math.floor(start / 1000); //get timestamp in whole seconds
var ets = Math.floor(end / 1000); //get timestamp in whole seconds
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
var logfile = path.join(__dirname, dbDir, dbLog.getLogName(dbNode._id, metricKey));
var count = dbLog.editData(logfile, sts, ets, newValue);
console.info(`EDITMETRICDATA DB-Updated points:${count} to:${newValue}`);
socket.emit('EDITMETRICDATA_OK', count); //post it back to requesting client only
}
});
});
socket.on('CONTROLCLICK', function (control) {
if (control.action) sendMessageToNode({nodeId:control.nodeId, action:control.action});
//console.log('CONTROLCLICK:' + JSON.stringify(control));
if (control.nodeType && control.controlKey && control.stateKey)
if (metricsDef.motes[control.nodeType].controls[control.controlKey].states[control.stateKey].serverExecute != null)
{
db.findOne({ _id : control.nodeId }, function (err, node) {
if (node)
{
//console.log('CONTROLCLICK running node:' + JSON.stringify(node));
metricsDef.motes[control.nodeType].controls[control.controlKey].states[control.stateKey].serverExecute(node);
}
});
}
});
socket.on('NODEMESSAGE', function (msg) {
sendMessageToNode(msg);
});
socket.on('SIMULATEDMESSAGE', function (str) {
if (str) processSerialData(str, true);
});
socket.on('GATEWAYMESSAGE', function (msg) {
sendMessageToGateway(msg);
});
socket.on('ADDNEWNODE', function(node) {
if (isValidNodeId(node.nodeId))
{
node.nodeId = parseInt(node.nodeId);
//only add node if given ID does not already exist in the DB
db.findOne({_id:node.nodeId}, function (err, doc) {
if (doc == null)
{
var entry = { _id:node.nodeId, updated:Date.now(), label:node.label || 'NEW NODE', metrics:{} };
db.insert(entry);
console.info(` [${node.nodeId}] DB-Insert new _id:${node.nodeId}`);
socket.emit('LOG', 'NODE ADDED, ID: ' + node.nodeId);
io.sockets.emit('UPDATENODE', entry);
}
else
socket.emit('LOG', 'CANNOT ADD NODE, ID ALREADY EXISTS: ' + node.nodeId);
});
}
else socket.emit('LOG', 'CANNOT ADD NODE, INVALID NEW ID: ' + node.nodeId);
});
socket.on('SUBMITNODEREQUEST', function (nodeId, reqName, reqValue, reqTimeout) {
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
if (dbNode.requests == undefined) dbNode.requests = {};
isNew = false;
if (dbNode.requests[reqName] == null) {
dbNode.requests[reqName] = {};
isNew = true;
}
dbNode.requests[reqName].name = reqName;
dbNode.requests[reqName].value = reqValue;
dbNode.requests[reqName].updated = Date.now();
dbNode.requests[reqName].status = 'PENDING';
dbNode.requests[reqName].timeout = reqTimeout || ONEDAY;
requestString='';
if (!isNew) //VOID previous request value before queuing adding latest value
requestString += nodeId + ':VOID:' + reqName + (reqValue?':'+reqValue.trim():'') + '\n';
requestString += 'REQUESTQUEUE:' + nodeId + ':' + reqName + (reqValue?':'+reqValue.trim():'') + '\n';
sendMessageToGateway(requestString);
console.info('REQUEST SENT: ' + requestString.replaceNewlines());
db.update({ _id: dbNode._id }, { $set : dbNode}, {}, function (err, numReplaced) { console.info('SUBMITNODEREQUEST DB-Replaced:' + numReplaced); });
console.info(` [${nodeId}] ${(isNew?'Added':'Updated')} request:${reqName}`);
socket.emit('LOG', 'NODE ['+nodeId+'] Request '+(isNew?'Added':'Updated')+': ' + reqName);
io.sockets.emit('UPDATENODE', dbNode);
}
});
});
socket.on('GETGRAPHDATA', function (nodeId, metricKey, start, end, exportMode) {
var graphData = getGraphData(nodeId, metricKey, start, end, exportMode);
socket.emit(exportMode ? 'EXPORTGRAPHDATAREADY' : 'GRAPHDATAREADY', graphData);
});
socket.on('GETMULTIGRAPHDATA', function (nodeId, multiGraphId, start, end, exportMode) {
var sts = Math.floor(start / 1000); //get timestamp in whole seconds
var ets = Math.floor(end / 1000); //get timestamp in whole seconds
var series = [];
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
if (dbNode.multiGraphs && dbNode.multiGraphs[multiGraphId])
{
var multiGraphKeysArray = dbNode.multiGraphs[multiGraphId];
Object.keys(dbNode.metrics).forEach(function(mKey,index) { //syncronous/blocking call
if (multiGraphKeysArray.includes(mKey) && dbNode.metrics[mKey].graph == 1) {
var graphData = getGraphData(nodeId, mKey, start, end, exportMode);
series.push(graphData);
}
});
socket.emit(exportMode ? 'EXPORTMULTIGRAPHDATAREADY' : 'MULTIGRAPHDATAREADY', series);
}
}
});
});
socket.on('EXPORTNODELOGSCSV', function (nodeId, start, end, howManyPoints) {
var sts = Math.floor(start / 1000); //get timestamp in whole seconds
var ets = Math.floor(end / 1000); //get timestamp in whole seconds
var sets = [];
db.find({ _id : nodeId }, function (err, entries) {
if (entries.length == 1)
{
var dbNode = entries[0];
Object.keys(dbNode.metrics).forEach(function(mKey,index) { //syncronous/blocking call
if (dbNode.metrics[mKey].graph == 1) {
var logfile = path.join(__dirname, dbDir, dbLog.getLogName(dbNode._id, mKey));
var theData = dbLog.getData(logfile, sts, ets, howManyPoints /*settings.general.graphMaxPoints.value*/);
theData.label = dbNode.metrics[mKey].label || mKey;
sets.push(theData); //100k points when exporting, more points is really pointless
}
});
socket.emit('EXPORTNODELOGSCSVREADY', { sets:sets });
}
});
});
socket.on('UPDATESETTINGSDEF', function (newSettings) {
//console.info(`UPDATESETTINGSDEF requested, new settings: ${JSON.stringify(newSettings)}`);
var settings = nconf.get('settings');
var changed=false;
var baudChangedTo = 0;
var portChangedTo = undefined;
for(var sectionName in settings)
{
var sectionSettings = settings[sectionName];
if (sectionSettings.exposed===false || sectionSettings.editable===false) continue;
for(var settingName in sectionSettings)
{
var setting = sectionSettings[settingName];
if (setting.exposed===false || setting.editable===false) continue
if (setting.value == undefined || newSettings[sectionName][settingName].value == undefined) continue;
if (setting.value != newSettings[sectionName][settingName].value) {
changed=true;
setting.value = newSettings[sectionName][settingName].value;
if (settingName=='baud') baudChangedTo = setting.value;
if (settingName=='port') portChangedTo = setting.value;
}
}
}
if (changed) {
global.settings = settings;
nconf.save(function (err) {
if (err !=null)
socket.emit('LOG', 'UPDATESETTINGSDEF ERROR: '+err);
else
io.sockets.emit('SETTINGSDEF', settings);
});
if (portChangedTo) {
log = `PORT changed to ${portChangedTo} - reopening serial port @ ${settings.serial.baud.value} baud...`;
openPort(true);
console.log(log);
socket.emit('LOG', log);
}
else if (baudChangedTo) {
log = `BAUD changed to ${baudChangedTo} - updating port baud speed...`;
port.drain();
port.update({baudRate: baudChangedTo},function(err,res) { if (err) console.error(err) });
console.log(log);
socket.emit('LOG', log);
}
}
});
socket.on('PROCESSEXIT', function () {
console.log('PROCESS EXIT REQUESTED from ' + address);
process.exit();
});
socket.on('RESTARTPI', function () {
console.log('PI RESTART REQUESTED from ' + address);
require('child_process').exec('sudo /sbin/shutdown -r now "GATEWAY RESTART REQUEST"', function (msg) { console.log(msg) });
});
socket.on('SHUTDOWNPI', function () {
console.log('PI SHUTDOWN REQUESTED from ' + address);
require('child_process').exec('sudo /sbin/shutdown now "GATEWAY SHUTDOWN REQUEST"', function (msg) { console.log(msg) });
});
});
//entries should contain the node list and also a node that contains the order (if this was ever added)
function sortNodes(entries) {
var orderCSV;
for (var i = entries.length-1; i>=0; i--)
if (!isValidNodeId(entries[i]._id)) //remove non-numeric id nodes
{
if ((entries[i]._id).toString().toUpperCase() == 'NODELISTORDER') //if node order entry was found, remember it
orderCSV = entries[i].order.split(',');
entries.splice(i,1);
}
//sort the list if nodes order entry was found, otherwise do a default ordering by label or by id when no label is set
entries.sort(orderCSV !== undefined ?
function (a, b) { return orderCSV.indexOf(a._id.toString()) - orderCSV.indexOf(b._id.toString()); }
: //else:
function(a,b){ if (a.label && b.label) return a.label < b.label ? -1 : 1; if (a.label) return -1; if (b.label) return 1; return a._id.toString() > b._id.toString(); }
);
return entries;
}
global.handleNodeRequest = function (existingNode, reqName, oldValue, newValue, returnedStatus, timeout) {
existingNode.requests[reqName].value = newValue;
existingNode.requests[reqName].updated = Date.now();
existingNode.requests[reqName].timeout = timeout;
if (['PENDING','INVALID','CHANGED'].indexOf(existingNode.requests[reqName].status) > -1)
sendMessageToGateway(existingNode._id+':VOID:'+reqName+(oldValue?':'+oldValue:'')); //remove pending request from gateway's REQUEST queue
if (oldValue == undefined)
existingNode.requests[reqName].status = 'OK';
else if (oldValue == newValue)
{
if (existingNode.requests[reqName].status != 'CHANGED')
existingNode.requests[reqName].status = 'OK';
}
else
existingNode.requests[reqName].status = 'CHANGED';
if (returnedStatus == 'INV')
existingNode.requests[reqName].status = 'INVALID';
else if (returnedStatus)
existingNode.requests[reqName].status = returnedStatus; //override status with returnedStatus, if any returned
}
global.msgHistory = new Array();
global.processSerialData = function (data, simulated) {
var regexNodeData = /\[(\d+)\]([a-z0-9!"#\$%&'()*+,.\/:;<=>?@\[\] ^_`{|}~-]+)/ig; //modifiers: g:global i:caseinsensitive
var regexTokenizedLine = /[a-z0-9!"#\$%&'()*+,.\/:;<=>?@\[\]^_`{|}~-]+/ig; //match (almost) any non whitespace human readable character
var regexpGeneralRequests = /^([_a-z][_a-z0-9]*)(\:[-_a-z0-9]+)?(\:[-_a-z0-9]+)?(\:[-_a-z0-9]+)?$/i; //up to 5 capture groups: [0]whole_string [1]name ([2]:optional value) ([3]:optional status) ([4]:optional extra)
var match = regexNodeData.exec(data);
let log = `${settings.serial.port.value}${simulated?'(simulated)':''}>:` + data;
console.log(log)
io.sockets.emit('LOG', log);
//first try to match normal data from nodes: [nodeID] token:value ... token:value RSSI:-XX
if (match != null)
{
var msgTokens = match[2];
var id = parseInt(match[1]); //get ID of node
db.findOne({ _id : id }, function (err, dbEntry) {
var existingNode = {};
var hasMatchedMetrics = false;
if (dbEntry != null) existingNode = dbEntry; //update
//check for duplicate messages - this can happen when the remote node sends an ACK-ed message but does not get the ACK so it resends same message repeatedly until it receives an ACK
if (existingNode.updated != undefined && (Date.now() - existingNode.updated < 500) && msgHistory[id] == msgTokens)
{
console.log(" DUPLICATE, skipping...");
return;
}
msgHistory[id] = msgTokens;
existingNode._id = id;
existingNode.updated = Date.now(); //update timestamp we last heard from this node, regardless of any matches
if (existingNode.metrics == undefined) existingNode.metrics = {};
if (existingNode.requests == undefined) existingNode.requests = {};
while (match = regexTokenizedLine.exec(msgTokens)) //extract each token/value pair from the message and process it
{
var matchingMetric;
//try to match a metric definition
for(var metric in metricsDef.metrics)
{
if (metricsDef.metrics[metric].regexp.test(match[0]))
{
//found matching metric, extract the token:value and add/update the node with it
var tokenMatch = metricsDef.metrics[metric].regexp.exec(match[0]);
matchingMetric = metricsDef.metrics[metric];
//handle TYPE metric
if (metric == 'TYPE') {
nodetype = determineValue(matchingMetric, tokenMatch);
if (metricsDef.motes[nodetype] && existingNode.type !== nodetype) {
existingNode.type = nodetype;
existingNode.icon = metricsDef.motes[nodetype].icon || existingNode.icon;
}
continue;
}
//handle requests - they are of this format: REQUEST_NAME:REQUEST_VALUE(:OPTIONAL_REQUEST_STATUS)
//regex definitions in core.js gives the strict format and case sensitivity
if (matchingMetric.isRequest)
{
reqName = matchingMetric.name;
if (existingNode.requests[reqName] == null) {
existingNode.requests[reqName] = {};
}
newValue = matchingMetric.value || tokenMatch[1] || tokenMatch[0];
oldValue = existingNode.requests[reqName].value;
returnedStatus = tokenMatch[2];
timeout = matchingMetric.timeout*1000 || ONEDAY;
existingNode.requests[reqName].name = reqName;
handleNodeRequest(existingNode, reqName, oldValue, newValue, returnedStatus, timeout);
continue;
}
//handle all other regular metrics
if (existingNode.metrics[matchingMetric.name] == null) existingNode.metrics[matchingMetric.name] = {};
existingNode.metrics[matchingMetric.name].label = existingNode.metrics[matchingMetric.name].label || matchingMetric.name;
existingNode.metrics[matchingMetric.name].descr = existingNode.metrics[matchingMetric.name].descr || matchingMetric.descr || undefined;
existingNode.metrics[matchingMetric.name].value = matchingMetric.value || determineValue(matchingMetric, tokenMatch);
existingNode.metrics[matchingMetric.name].unit = matchingMetric.unit || undefined;
existingNode.metrics[matchingMetric.name].updated = existingNode.updated;
existingNode.metrics[matchingMetric.name].pin = existingNode.metrics[matchingMetric.name].pin != undefined ? existingNode.metrics[matchingMetric.name].pin : matchingMetric.pin;
existingNode.metrics[matchingMetric.name].graph = existingNode.metrics[matchingMetric.name].graph != undefined ? existingNode.metrics[matchingMetric.name].graph : matchingMetric.graph;
//log data for graphing purposes, keep labels as short as possible since this log will grow indefinitely and is not compacted like the node database
if (existingNode.metrics[matchingMetric.name].graph==1)
{
var graphValue = isNumeric(matchingMetric.logValue) ? matchingMetric.logValue : determineGraphValue(matchingMetric, tokenMatch); //existingNode.metrics[matchingMetric.name].value;
if (isNumeric(graphValue))
{
var ts = Math.floor(Date.now() / 1000); //get timestamp in whole seconds
var logfile = path.join(__dirname, dbDir, dbLog.getLogName(id, matchingMetric.name));
try {
console.log('post: ' + logfile + '[' + ts + ','+graphValue + ']');
dbLog.postData(logfile, ts, graphValue, matchingMetric.duplicateInterval || null);
} catch (err) { console.error(' POST ERROR: ' + err.message); /*console.log(' POST ERROR STACK TRACE: ' + err.stack); */ } //because this is a callback concurrent calls to the same log, milliseconds apart, can cause a file handle concurrency exception
}
else console.log(' METRIC NOT NUMERIC, logging skipped... (extracted value:' + graphValue + ')');
}
if (matchingMetric.name != 'RSSI') hasMatchedMetrics = true; //excluding RSSI because noise can produce a packet with a valid RSSI reading
break; //--> this stops matching as soon as 1 metric definition regex is matched on the data. You could keep trying to match more definitions and that would create multiple metrics from the same data token, but generally this is not desired behavior. In that case the on-the-fly request matching section below should be done conditionally - only if no defined metrics matched
}
}
//no matched metrics, last chance: look for any on-the-fly/manually added requests or requests with custom/unknown/non-matching statuses
var tokenMatch = regexpGeneralRequests.exec(match[0]);
if (tokenMatch) {
reqName = tokenMatch[1];
if (existingNode.requests && existingNode.requests[reqName] != null) //found an on-the-fly node request for the node
{
newValue = (tokenMatch[2] || '').replace(/^\:/, ''); //get captured value, if any
oldValue = existingNode.requests[reqName].value;
returnedStatus = (tokenMatch[3] || '').replace(/^\:/, '');
timeout = existingNode.requests[reqName].timeout || ONEDAY;
handleNodeRequest(existingNode, reqName, oldValue, newValue, returnedStatus, timeout);
}
}
else if (!hasMatchedMetrics) { //else : we do not generate unknown requests (not defined in metrics) by default even if they are transmitted
console.log('NODEDATA PARTIAL NOMATCH>: ' + match[0].replaceNewlines());
if (unmatchedDataDB)
unmatchedDataDB.insert({_id:Date.now(), data:match[0]});
}
}
//prepare entry to save to DB, undefined values will not be saved, hence saving space
var entry = {
_id:id,
updated:existingNode.updated,
type:existingNode.type||undefined,
label:existingNode.label||undefined,
descr:existingNode.descr||undefined,
hidden:existingNode.hidden||undefined,
rssi:existingNode.rssi,
metrics:Object.keys(existingNode.metrics).length > 0 ? existingNode.metrics : undefined,
requests:Object.keys(existingNode.requests).length > 0 ? existingNode.requests : undefined,
events:existingNode.events,
settings:existingNode.settings,
multiGraphs:existingNode.multiGraphs,
icon:existingNode.icon||undefined
};
//save to DB
if (dbEntry==null) //it is an INSERT
{
if (settings.general.genNodeIfNoMatch.value == true || settings.general.genNodeIfNoMatch.value == 'true' || hasMatchedMetrics)
{
db.insert(entry);
console.info(` [${id}] DB-Insert new _id:${id}`);
io.sockets.emit('UPDATENODE', entry);
return;
}
}
else {
db.update({ _id: id }, { $set : entry}, {}, function (err, numReplaced) { console.info(`[${id}] DB-Updated: processSerialData('${data.replaceNewlines()}',${simulated}):entry=${JSON.stringify(entry)}`);});
io.sockets.emit('UPDATENODE', entry);
}
//handle any server side events (email, sms, custom actions)
handleNodeEvents(entry);
});
}
else
{
somethingMatched=false;
validTokenMatched=false;
if (data.startsWith('DEBUG:')) {
return; //it is already logged
}
//atempt to process any commands/requests between gateway.js server and serial RF GATEWAY
while (match = regexTokenizedLine.exec(data)) //extract each whitespace separated token/value pair from serial data and process it
{
somethingMatched=true;
var tokenMatch = regexpGeneralRequests.exec(match[0]); //format is REQUEST:VALUE:STATUS with VALUE and STATUS optional
var partialMatch = false;
//check "known" REQUESTs
if (tokenMatch != null) {
updateServerInfo=false;
tokenValue = (tokenMatch[2] || '').replace(/^\:/, '');
if (tokenMatch[1] == 'GATEWAYSTART') //indicates a GATEWAY (re)start
{
gatewayUptime = Date.now();
updateServerInfo=true;
validTokenMatched=true;
partialMatch = true;
// if for any reason the RF gateway resets, any queued REQUESTS are lost (the queue is dynamically allocated in RAM)
// hence: (re)send any PENDING requests for any nodes to make sure the GATEWAY has them ready for the (sleepy) target nodes
db.find({ _id : { $exists: true }, requests : { $exists: true } }, function (err, entries) {
var updates = [];
var ts = Date.now();
for (var i = 0; i < entries.length; i++) {
var nodeUpdated=false;
var dbNode = entries[i];
for (var key in dbNode.requests) {
if (dbNode.requests[key].status=='PENDING')
{
reqValue = dbNode.requests[key].value;
reqStr = dbNode._id + ':' + dbNode.requests[key].name + (reqValue?':'+reqValue.trim():'') + '\n';
console.log('REQUEUING: ' + reqStr);
sendMessageToGateway(reqStr);
}