forked from OttHydromet/node-red-umbparser
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathumbparser.js
More file actions
896 lines (789 loc) · 26 KB
/
umbparser.js
File metadata and controls
896 lines (789 loc) · 26 KB
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
/**
* Copyright (c) 2020 OTT Hydromet Fellbach GmbH
*
* UMB parser objects
*
* @summary UMB parser objects
* @author Martin Kiepfer <martin.kiepfer@otthydromet.com>
*/
const CRC = require('crc-full').CRC;
const umb_consts = require('./umb_consts').umb_consts;
/**
* Detailed parsing frame state
*/
const FRAME_STATE =
{
PAR_SOH : 0,
PAR_VER : 1,
PAR_TO_LSB : 2,
PAR_TO_MSB : 3,
PAR_FROM_LSB : 4,
PAR_FROM_MSB : 5,
PAR_LEN : 6,
PAR_STX : 7,
PAR_CMD : 8,
PAR_CMD_VER : 9,
PAR_PAYLOAD : 10,
PAR_ETX : 11,
PAR_CRC_LSB : 12,
PAR_CRC_MSB : 13,
PAR_EOT : 14
}
/**
* General parsing state
*/
const PAR_STATE =
{
PARSER_IDLE : 'idle',
PARSER_PROCESSING : 'processing',
PARSER_ERROR : 'parsing error',
PARSER_CRCERROR : 'crc_error',
PARSER_FINISHED : 'finished',
}
/**
* Frame types
*/
const FRAME_TYPE =
{
REQUEST: 'request',
RESPONSE: 'response',
UNKNOWN: 'unknown'
}
/**
* UMBFrame base class
*/
class UMBFrame
{
frametype;
payload;
cmd;
status;
crc;
framedata;
/**
*
*/
constructor()
{
this.frametype = FRAME_TYPE.UNKNOWN;
this.payload = new Uint8Array();
this.cmd = 0;
this.status = -1;
this.crc = 0xFFFF;
this.framedata;
}
}
/**
* UMB frame data class
* This oject is the basic object for all information about a parsed UMB frame
*/
class UMBFrameData
{
name = "";
raw = [];
parsed = [];
/**
*
* @param {string} name Name/Type of the parsed frame
* @param {object[]} rawdata Detailed raw data of the parse frame (e.g. MeasChVal)
* @param {object[]} parsedata Processed parsed data to be used for further proceeding (JSON)
*/
constructor(name, rawdata, parsedata)
{
this.name = name
this.raw = rawdata;
this.parsed = parsedata;
}
}
/**
* Measurement channel object
*/
class MeasChVal
{
ch_number;
ch_value;
ch_data_type;
ch_status;
/**
* MeasChVal constructor
* @param {Number} number Channel number
* @param {Number} value Channe value
* @param {String} data_type Data type
* @param {Number} status Channel status
*/
constructor(number, data_type, status, dview)
{
this.ch_number = number; // Kanalnummer
this.ch_data_type = MeasChVal.getDataTypeName(data_type); // Datentype
this.ch_status = status; // UMB-Status
this.ch_value = NaN;
switch(data_type)
{
case 0x10:
this.ch_value = dview.getUint8(0);
break;
case 0x11:
this.ch_value = dview.getInt8(0);
break;
case 0x12:
this.ch_value = dview.getUint16(0, true);
break;
case 0x13:
this.ch_value = dview.getInt16(0, true);
break;
case 0x14:
this.ch_value = dview.getUint32(0, true);
break;
case 0x15:
this.ch_value = dview.getInt32(0, true);
break;
case 0x16:
this.ch_value = dview.getFloat32(0, true);
break;
case 0x17:
this.ch_value = dview.getFloat64(0, true);
break;
}
}
static getDataTypeName(dtype)
{
let ch_data_type = "UNKOWN";
switch(dtype)
{
case 0x10:
ch_data_type = "UCHAR";
break;
case 0x11:
ch_data_type = "SCHAR";
break;
case 0x12:
ch_data_type = "USHORT";
break;
case 0x13:
ch_data_type = "SSHORT";
break;
case 0x14:
ch_data_type = "ULONG";
break;
case 0x15:
ch_data_type = "SLONG";
break;
case 0x16:
ch_data_type = "FLOAT";
break;
case 0x17:
ch_data_type = "DOUBLE";
break;
}
return ch_data_type;
}
static getMeasTypeName(chtype)
{
let meas_name = "UNKOWN";
switch(chtype)
{
case 0x10:
meas_name = "Current";
break;
case 0x11:
meas_name = "Minimum";
break;
case 0x12:
meas_name = "Maximum";
break;
case 0x13:
meas_name = "Average";
break;
case 0x14:
meas_name = "Sum";
break;
case 0x15:
meas_name = "Vector";
break;
}
return meas_name;
}
static parseDataValue(dtype, dvalue)
{
var retval;
switch(dtype)
{
case "UCHAR":
case "SCHAR":
retval = dvalue.toString();
break;
case "USHORT":
case "SSHORT":
case "ULONG":
case "SLONG":
retval = parseInt(dvalue.toFixed());
break;
case "FLOAT":
case "DOUBLE":
default:
retval = parseFloat(dvalue.toPrecision(3));
break;
}
return retval;
}
}
/**
* UMB base class
*/
class UMBBase
{
_CRC;
_node;
constructor(node)
{
this._node = node;
this._CRC = new CRC("CRC16", 16, 0x1021, 0xFFFF, 0x0000, true, true);
}
get CRC() {
return this._CRC;
}
get node()
{
return this._node;
}
/**
* Returns the 8-bit checksum given an array of byte-sized numbers
* @param {Array} byte_array Byte array to calculate the CRC on
*/
calcCRC(byte_array)
{
return this._CRC.compute(byte_array);
}
/**
* Internal method to retrive the payload index according to the given frame type
* @param {FRAME_TYPE} frame_type Response or Request
*/
static getPayloadDataIndex(frame_type)
{
let uDataIdx = (umb_consts.UMBFRAME_IDX.CMDV + 1);
switch (frame_type)
{
case FRAME_TYPE.RESPONSE:
//@TODO
//if (UmbDispatcher_HasSubCmd(UMBFrame_getCmd(pFrame), UMBFrame_getCmdVer(pFrame)))
if(0)
{
uDataIdx = (umb_consts.UMBFRAME_IDX.SUBCMD + 1);
}
else
{
uDataIdx = (umb_consts.UMBFRAME_IDX.RES_STATUS + 1);
}
break;
case FRAME_TYPE.REQUEST:
//@TODO
//if (UmbDispatcher_HasSubCmd(UMBFrame_getCmd(pFrame), UMBFrame_getCmdVer(pFrame)))
if(0)
{
uDataIdx = (umb_consts.UMBFRAME_IDX.SUBCMD + 1);
}
else
{
uDataIdx = (umb_consts.UMBFRAME_IDX.CMDV + 1);
}
break;
default:
uDataIdx = (umb_consts.UMBFRAME_IDX.CMDV + 1);
break;
}
return uDataIdx;
}
}
/**
* UMB parser class
*/
class UMBParser extends UMBBase
{
#readBuffer;
#parsingIdx;
#parsingSOHIdx;
#parsingETXIdx;
#parsingCRC;
#payloadCnt;
#frameState;
#parserState;
#payload;
#channelmap;
/**
* Basic constructor
*/
constructor(node)
{
super(node);
this.#readBuffer = new Array();
this.#parsingIdx = 0;
this.#parsingSOHIdx = 0;
this.#parsingETXIdx = 0;
this.#parsingCRC = 0;
this.#payloadCnt = 0;
this.#frameState = FRAME_STATE.PAR_SOH;
this.#parserState = PAR_STATE.PARSER_PROCESSING;
this.#payload = new Uint8Array();
this.#channelmap = new Map(this.node.cfg_channels.channels.map(i => [parseInt(i.ch), i.chname]));
}
/**
* This function resets the internal parserr state
*/
#resetParser(empty = false)
{
if(empty)
{
this.#readBuffer = new Array();
}
else
{
this.#readBuffer = this.#readBuffer.slice(this.#parsingSOHIdx);
}
this.#parsingSOHIdx = 0;
this.#parsingIdx = 0;
this.#payloadCnt = 0;
this.#parsingETXIdx = 0;
this.#payload = new Uint8Array();
this.#frameState = FRAME_STATE.PAR_SOH;
}
/**
* Parsing function.
* This function parses a binary stream of UMB data. The parsed buffer doesn't need the complete
* UMB frame, this function may be called repeatedly until the end of frame has been reached
* @param {ArrayBuffer} curBuffer Current binary data
*/
ParseReadBuf(curBuffer)
{
// return immediately if readLen == 0, handleTransfer now calls the parser also when
// no characters received (Modbus RTU)
if ((typeof curBuffer == ArrayBuffer) && (curBuffer.length == 0))
{
return;
}
// Push current data
this.#readBuffer.push.apply(this.#readBuffer, curBuffer);
while(this.#parsingIdx < this.#readBuffer.length)
{
switch(this.#frameState)
{
case FRAME_STATE.PAR_SOH:
if(this.#readBuffer[this.#parsingIdx] == umb_consts.UMBFRAME_VAL.SOH)
{
this.#parserState = PAR_STATE.PARSER_PROCESSING;
this.#frameState = FRAME_STATE.PAR_VER;
this.#parsingSOHIdx = this.#parsingIdx;
}
else
{
this.#parserState = PAR_STATE.PARSER_ERROR;
}
break;
case FRAME_STATE.PAR_VER:
//@note: This parser currently only supports UMB-V1.0
if(this.#readBuffer[this.#parsingIdx] == umb_consts.UMBFRAME_VERSION_V10)
{
this.#frameState = FRAME_STATE.PAR_TO_LSB;
}
else
{
this.#parserState = PAR_STATE.PARSER_ERROR;
}
break;
case FRAME_STATE.PAR_TO_LSB:
this.#frameState = FRAME_STATE.PAR_TO_MSB;
break;
case FRAME_STATE.PAR_TO_MSB:
this.#frameState = FRAME_STATE.PAR_FROM_LSB;
break;
case FRAME_STATE.PAR_FROM_LSB:
this.#frameState = FRAME_STATE.PAR_FROM_MSB;
break;
case FRAME_STATE.PAR_FROM_MSB:
this.#frameState = FRAME_STATE.PAR_LEN;
break;
case FRAME_STATE.PAR_LEN:
this.frameLength = this.#readBuffer[this.#parsingIdx];
if( (this.frameLength < umb_consts.UMBFRAME_MAX_LENGTH) &&
(this.frameLength > 2) )
{
this.#payloadCnt = 0;
this.#payload = new Uint8Array(this.frameLength - 2);
this.#frameState = FRAME_STATE.PAR_STX;
}
else
{
this.#frameState = FRAME_STATE.PARSER_ERROR;
}
break;
case FRAME_STATE.PAR_STX:
if(this.#readBuffer[this.#parsingIdx] == umb_consts.UMBFRAME_VAL.STX)
{
this.#frameState = FRAME_STATE.PAR_CMD;
}
else
{
this.#frameState = FRAME_STATE.PARSER_ERROR;
}
break;
case FRAME_STATE.PAR_CMD:
this.#frameState = FRAME_STATE.PAR_CMD_VER;
break;
case FRAME_STATE.PAR_CMD_VER:
this.#frameState = FRAME_STATE.PAR_PAYLOAD;
break;
case FRAME_STATE.PAR_PAYLOAD:
this.#payloadCnt++;
/* <CMD><VERC> are also included in <LEN>-field */
if(this.#payloadCnt <= (this.frameLength - 2))
{
/* Payload data */
this.#payload.set([this.#readBuffer[this.#parsingIdx]], this.#payloadCnt-1);
break;
}
else
{
this.#frameState = FRAME_STATE.PAR_ETX;
/* @note: Fall-Through!! */
}
/* no break */
case FRAME_STATE.PAR_ETX:
if(this.#readBuffer[this.#parsingIdx] == umb_consts.UMBFRAME_VAL.ETX)
{
this.#parsingETXIdx = this.#parsingIdx;
this.#frameState = FRAME_STATE.PAR_CRC_LSB;
}
else
{
this.#parserState = PAR_STATE.PARSER_ERROR;
}
break;
case FRAME_STATE.PAR_CRC_LSB:
this.#frameState = FRAME_STATE.PAR_CRC_MSB;
this.#parsingCRC = this.#readBuffer[this.#parsingIdx];
break;
case FRAME_STATE.PAR_CRC_MSB:
this.#parsingCRC |= (this.#readBuffer[this.#parsingIdx] << 8);
let crc = this.calcCRC(this.#readBuffer.slice(0, this.#parsingETXIdx+1));
if(crc == this.#parsingCRC)
{
this.#frameState = FRAME_STATE.PAR_EOT;
}
else
{
this.#parserState = PAR_STATE.PARSER_CRCERROR;
}
break;
case FRAME_STATE.PAR_EOT:
if(this.#readBuffer[this.#parsingIdx] == umb_consts.UMBFRAME_VAL.EOT)
{
/**
* At this state it looks like have a valid UMB Frame
*/
this.frameLength = 0;
this.#parserState = PAR_STATE.PARSER_FINISHED;
}
else
{
this.#parserState = PAR_STATE.PARSER_ERROR;
}
break;
default:
this.#parserState = PAR_STATE.PARSER_ERROR;
break;
} // switch END
this.#parsingIdx++;
/* Check parsing state */
if((this.#parserState == PAR_STATE.PARSER_ERROR) || (this.#parserState == PAR_STATE.PARSER_CRCERROR))
{
/* start parsing at last SOH */
this.#resetParser();
break;
}
}
// Finish parsing frame
let parsedFrame = new UMBFrame();
if(this.#parserState == PAR_STATE.PARSER_FINISHED)
{
parsedFrame.FromAddr = (this.#readBuffer[umb_consts.UMBFRAME_IDX.FROM_ADDR+1] << 8) | this.#readBuffer[umb_consts.UMBFRAME_IDX.FROM_ADDR];
parsedFrame.ToAddr = (this.#readBuffer[umb_consts.UMBFRAME_IDX.TO_ADDR+1] << 8) | this.#readBuffer[umb_consts.UMBFRAME_IDX.TO_ADDR];
parsedFrame.cmd = this.#readBuffer[umb_consts.UMBFRAME_IDX.CMD];
parsedFrame.payload = Object.assign({}, this.#payload);;
parsedFrame.crc = this.calcCRC(this.#readBuffer.slice(0, this.#parsingETXIdx));
if(((parsedFrame.FromAddr & 0xF000) == 0xF000) && ((parsedFrame.ToAddr & 0xF000) != 0xF000))
{
parsedFrame.frametype = FRAME_TYPE.REQUEST;
}
else if(((parsedFrame.FromAddr & 0xF000) != 0xF000) && ((parsedFrame.ToAddr & 0xF000) == 0xF000))
{
parsedFrame.frametype = FRAME_TYPE.RESPONSE;
parsedFrame.status = this.#payload[0];
}
else
{
parsedFrame.frametype = FRAME_TYPE.UNKNOWN;
}
// Analyse command
if((parsedFrame.frametype == FRAME_TYPE.RESPONSE) && (parsedFrame.status == umb_consts.ERROR_STATUS.STATUS_OK))
{
switch(parsedFrame.cmd)
{
case umb_consts.UMB_CMD.GETMULTICHANNEL:
parsedFrame.framedata = this.#cmdRespChData();
break;
case umb_consts.UMB_CMD.GETDEVINFO:
parsedFrame.framedata = this.#cmdRespDevinfo();
break;
}
}
this.#resetParser(true);
}
let retval = {
parserState: this.#parserState,
umbframe: parsedFrame
}
return retval;
}
/**
* Interal function to analyse channel query response data in more detail
* It does not need any paramter and uses the last internally
* parse frame data.
* This function will return a UMBFrameData() object with
* detailed information about the parsed frame
*/
#cmdRespChData()
{
let numChannels = this.#payload[1];
let index = 2;
let chData = new Array();
for(let i=0; i<numChannels; i++)
{
let curDataLen = this.#payload[index];
let curDataView = new DataView(this.#payload.buffer, index+1, curDataLen);
let ch_status = curDataView.getUint8(0);
if(ch_status == umb_consts.ERROR_STATUS.STATUS_OK)
{
let ch_number = curDataView.getUint16(1, true);
let ch_data_type = curDataView.getUint8(3);
let curMeasChVal = new MeasChVal(ch_number, ch_data_type, ch_status, new DataView(this.#payload.buffer, index+5))
chData.push(curMeasChVal);
}
index += curDataLen+1;
}
let measValues = new Object();
chData.forEach(element => {
let curMeasName = this.#channelmap.get(element.ch_number);
if (curMeasName in measValues)
{
this.node.error("Multiple measurements of " + curMeasName + " selected! Please make sure to query only one.");
}
measValues[curMeasName] = MeasChVal.parseDataValue(element.ch_data_type, element.ch_value);
});
let parsedData = new UMBFrameData("Multi channel data", chData, measValues);
return parsedData;
}
/**
* Interal function to analyse device info sub-commands
*/
#cmdRespDevinfo()
{
let retval = undefined;
switch(this.#payload[1])
{
case 0x15:
retval = this.#cmdRespDevinfo_ChNum();
break;
case 0x16:
retval = this.#cmdRespDevinfo_ChList();
break;
case 0x30:
retval = this.#cmdRespDevinfo_ChDetails();
break;
}
return retval;
}
/**
* Interal function to analyse device info sub-command to query
* number of channels
*/
#cmdRespDevinfo_ChNum()
{
let chData = new Array();
let numChannelsView = new DataView(this.#payload.buffer, 2, 2);
let numChannels = numChannelsView.getUint16(0, true);
let numBlocks = this.#payload[4];
let devInfoNumCh = new Object();
devInfoNumCh.numChannels = numChannels;
devInfoNumCh.numBlocks = numBlocks;
let parsedData = new UMBFrameData("Number of Channels", devInfoNumCh, devInfoNumCh);
return parsedData;
}
/**
* Interal function to analyse device info sub-command to query
* number of channels
*/
#cmdRespDevinfo_ChList()
{
let chList = new Array();
let index = 4;
let block = this.#payload[2];
let numChannels = this.#payload[3];
for(let i=0; i<numChannels; i++)
{
let curChannelView = new DataView(this.#payload.buffer, index, 2);
let curChannel = curChannelView.getUint16(0, true);
index += 2;
chList.push(curChannel);
}
let chListData = new Object();
chListData.block = block;
chListData.channels = chList;
let parsedData = new UMBFrameData("Channel list", chListData, chListData);
return parsedData;
}
/**
* Interal function to analyse device info sub-command to query
* number of channels
*/
#cmdRespDevinfo_ChDetails()
{
let chDetailsRaw = new Object();
let byteIdx = 0;
const payloadOffset = 2;
// <channel>2 <messgröße>20, <einheit>15, <mw_typ>, <date_typ>, <min>, <max>
let chDetailsDV1 = new DataView(this.#payload.buffer, payloadOffset, 2+20+15+1+1);
chDetailsRaw.channel = chDetailsDV1.getUint16(byteIdx, true);
byteIdx += 2;
chDetailsRaw.name = new TextDecoder("ISO-8859-1").decode(this.#payload.slice(byteIdx+payloadOffset, byteIdx+payloadOffset+20)).trimEnd();
byteIdx += 20;
chDetailsRaw.unit = new TextDecoder("ISO-8859-1").decode(this.#payload.slice(byteIdx+payloadOffset, byteIdx+payloadOffset+15)).trimEnd();
byteIdx += 15;
chDetailsRaw.ch_type = chDetailsDV1.getUint8(byteIdx, true);
byteIdx++;
chDetailsRaw.data_type = chDetailsDV1.getUint8(byteIdx, true);
byteIdx++;
let chDetails = Object.assign({}, chDetailsRaw);
chDetails.ch_type = MeasChVal.getMeasTypeName(chDetailsRaw.ch_type);
chDetails.data_type = MeasChVal.getDataTypeName(chDetailsRaw.data_type);
let parsedData = new UMBFrameData("Channel Details", chDetailsRaw, chDetails);
return parsedData;
}
}
/**
* UMB Frame generator object
*/
class UMBGenerator extends UMBBase
{
#frameBuffer;
/**
* UMBGenerator constructor
*/
constructor(node)
{
super(node);
this.#frameBuffer = Array();
}
/**
* Fill bais frame data
* @param {int} cmd UMB command
* @param {int} cmd_ver UMB version
* @param {int} to_addr 2byte UMB address of the destiation device
* @param {int} from_addr 2byte ZUMB address of the source device
*/
#createReq(cmd, cmd_ver, to_addr, from_addr)
{
this.#frameBuffer[umb_consts.UMBFRAME_IDX.SOH] = umb_consts.UMBFRAME_VAL.SOH;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.VER] = umb_consts.UMBFRAME_VERSION_V10;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.STX] = umb_consts.UMBFRAME_VAL.STX;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.LEN] = 2;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.TO_ADDR] = to_addr & 0xFF;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.TO_ADDR+1] = (to_addr & 0xFF00) >> 8;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.FROM_ADDR] = from_addr & 0xFF;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.FROM_ADDR+1] = (from_addr & 0xFF00) >>8;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.CMD] = cmd;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.CMDV] = cmd_ver;
}
/**
* This method will add the CRC and finalze an UMB frame
* based on the passed payload
* @param {int} payloadLength Length of the payload
*/
#genFrameCRCEnd(payloadLength)
{
let crc = 0xFFFF;
let newFrameLength;
this.#frameBuffer[umb_consts.UMBFRAME_IDX.LEN] = payloadLength + 2;
newFrameLength = umb_consts.UMBFRAME_FRAME_LENGTH_OVERHEAD + this.#frameBuffer[umb_consts.UMBFRAME_IDX.LEN];
this.#frameBuffer[newFrameLength - 4] = umb_consts.UMBFRAME_VAL.ETX;
crc = this.calcCRC(this.#frameBuffer.slice(0, newFrameLength - 3))
this.#frameBuffer[newFrameLength - 2] = (crc >> 8) & 0xFF;
this.#frameBuffer[newFrameLength - 3] = crc & 0xFF;
this.#frameBuffer[newFrameLength - 1] = umb_consts.UMBFRAME_VAL.EOT;
}
/**
* This method generates a mutlichannel UMB request
*
* @param {number} to_addr Desination addess for the gernerated UMB request
* @param {Array} channellist List of channels to query
*/
createMultiChReq(to_addr, channellist)
{
this.#createReq(umb_consts.UMB_CMD.GETMULTICHANNEL, 0x10, to_addr, umb_consts.UMBFRAME_CONTROLLER_ADDR);
let payloadIndex = UMBBase.getPayloadDataIndex(FRAME_TYPE.REQUEST);
let payloadLength = 1+channellist.length*2;
let chbuf = new Uint8Array(payloadLength);
let chbuf_view = new DataView(chbuf.buffer);
// [0] - <num channels>
chbuf_view.setUint8(0, channellist.length);
// [1..n] - <channels>^2
for(let i=0; i<channellist.length; i++)
{
chbuf_view.setUint16(1+i*2, channellist[i], true);
}
for(let i=0; i<chbuf.length; i++)
{
this.#frameBuffer[payloadIndex+i] = chbuf[i];
}
this.#genFrameCRCEnd(payloadLength);
return Buffer.from(this.#frameBuffer);
}
/**
* This method generates a device info request
*
* @param {number} to_addr Desination addess for the gernerated UMB request
* @param {uint8} subcmd subcommand
* @param {array} parm parameter
*/
createDevInfoReq(to_addr, subcmd, option=undefined)
{
this.#createReq(umb_consts.UMB_CMD.GETDEVINFO, 0x10, to_addr, umb_consts.UMBFRAME_CONTROLLER_ADDR);
let payloadIndex = UMBBase.getPayloadDataIndex(FRAME_TYPE.REQUEST);
let payloadLength = 0;
this.#frameBuffer[payloadIndex++] = subcmd;
payloadLength++;
if((option != undefined) && (Array.isArray(option))) {
option.forEach(element => {
this.#frameBuffer[payloadIndex] = element;
payloadLength++;
payloadIndex++
});
}
this.#genFrameCRCEnd(payloadLength);
return Buffer.from(this.#frameBuffer);
}
createChNumReq(to_addr)
{
return this.createDevInfoReq(to_addr, 0x15)
}
createChListReq(to_addr, block)
{
return this.createDevInfoReq(to_addr, 0x16, [block])
}
createChDetailsReq(to_addr, channel)
{
return this.createDevInfoReq(to_addr, 0x30, [channel&0xFF, (channel&0xFF00)>>8])
}
}
module.exports.UMBParser = UMBParser;
module.exports.UMBGenerator = UMBGenerator;
module.exports.MeasChVal = MeasChVal;
module.exports.PAR_STATE = PAR_STATE;