-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathlmclient.js
2117 lines (2107 loc) · 100 KB
/
lmclient.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
/**
* @project LMClient
* @file Класс клиента сервера LM
* @copyright ООО МНПП Сатурн
*/
const EventEmitter = require('events');
const net = require('net');
const clientHiVersion = 1; // версия клиента
const clientLoVersion = 0;
// значения свойства quality канала
const stOk = 0; // ok
const stTempOff = 1; // выключен (не опрашивается)
const stOff = 2; // состояние не определено (нет данных)
const stError = 3; // неисправность
const stFailure = 4; // неисправность
const stWrong = 5; // значение недостоверно
const stNotConnected = 6; // датчик не подключен
const stBadConnection = 7; // неисправность канала связи
const stRegFailure = 8; // неисправен регистратор
// значения поддерживаемых типов данных
const VT_EMPTY = 0;
const VT_I2 = 2;
const VT_I4 = 3;
const VT_R4 = 4;
const VT_R8 = 5;
const VT_DATE = 7;
const VT_BOOL = 11;
const VT_I1 = 16;
const VT_UI1 = 17;
const VT_UI2 = 18;
const VT_UI4 = 19;
const VT_STRING = 256;
const VT_ARRAY = 4096;
const VT_MASK = 4095;
const validTypes = [VT_EMPTY, VT_I2, VT_I4, VT_R4, VT_R8, VT_DATE, VT_BOOL, VT_I1, VT_UI1, VT_UI2, VT_UI4, VT_STRING];
// идентификаторы атрибутов
const ATTR_EUType = 7;
const ATTR_EUInfo1 = 9;
const ATTR_EUInfo2 = 10;
const ATTR_EUInfo3 = 11;
const ATTR_UNITS = 100;
const ATTR_COMMENT = 101;
const ATTR_HIGHEU = 102;
const ATTR_LOEU = 103;
const ATTR_HIGHIRANGE = 104;
const ATTR_LOIRANGE = 105;
const ATTR_CONCLOSELABEL = 106;
const ATTR_CONOPENLABEL = 107;
const ATTR_TIMEZONE = 108;
const ATTR_QUALITYEXPRESSION= 109;
const ATTR_VALUEEXPRESSION = 110;
const ATTR_PERCENTDB = 111;
const ATTR_PREFIX = 112;
const ATTR_FGCOLOR = 201;
const ATTR_BGCOLOR = 202;
const ATTR_BLINK = 203;
const ATTR_BMPFILE = 204;
const ATTR_SOUNDFILE = 205;
const ATTR_ALARMMESSAGE = 301;
const ATTR_ALARMAREALIST = 302;
const ATTR_PRIMALARMAREA = 303;
const ATTR_CONDLOGIC = 304;
const ATTR_LIMITEXCEEDED = 305;
const ATTR_DEADBAND = 306;
const ATTR_HIHILIMIT = 307;
const ATTR_HILIMIT = 308;
const ATTR_LOLIMIT = 309;
const ATTR_LOLOLIMIT = 310;
const ATTR_RATECHANGELIMIT = 311;
const ATTR_DEVIATIONLIMIT = 312;
const ATTR_WATCHLIMIT = 314;
const ATTR_DESCRIPTION = 5000;
const ATTR_CONQUALITY = 5001;
const ATTR_FORMAT = 5002;
const ATTR_MASKED = 5003;
const ATTR_DTYPE = 5004;
const ATTR_SYSM = 5005;
const ATTR_ALARMID = 5006;
const ATTR_DEVICE = 5007;
const ATTR_USERTAG = 5008;
const ATTR_SIGNIFICATION = 5009;
const ATTR_NAMUR = 5010;
const ATTR_TAMPER = 5011;
const ATTR_VALUECHEXPRESSION= 5012;
const ATTR_BESTRECEIVER = 5014;
const ATTR_BESTREPEATER = 5015;
const ATTR_STORAGENUMBER = 5200;
const ATTR_TARIFNUMBER = 5201;
const ATTR_UNITNUMBER = 5202;
// типы атрибутов
const validAttributes = {};
validAttributes[ATTR_EUType] = VT_I2;
validAttributes[ATTR_EUInfo1] = VT_R8 + VT_ARRAY;
validAttributes[ATTR_EUInfo2] = VT_STRING + VT_ARRAY;
validAttributes[ATTR_EUInfo3] = VT_I4;
validAttributes[ATTR_UNITS] = VT_STRING;
validAttributes[ATTR_COMMENT] = VT_STRING;
validAttributes[ATTR_HIGHEU] = VT_R8;
validAttributes[ATTR_LOEU] = VT_R8;
validAttributes[ATTR_HIGHIRANGE] = VT_R8;
validAttributes[ATTR_LOIRANGE] = VT_R8;
validAttributes[ATTR_CONCLOSELABEL] = VT_STRING;
validAttributes[ATTR_CONOPENLABEL] = VT_STRING;
validAttributes[ATTR_TIMEZONE] = VT_I4;
validAttributes[ATTR_QUALITYEXPRESSION] = VT_STRING;
validAttributes[ATTR_VALUEEXPRESSION] = VT_STRING;
validAttributes[ATTR_PERCENTDB] = VT_R4;
validAttributes[ATTR_PREFIX] = VT_STRING;
validAttributes[ATTR_FGCOLOR] = VT_I4;
validAttributes[ATTR_BGCOLOR] = VT_I4;
validAttributes[ATTR_BLINK] = VT_BOOL;
validAttributes[ATTR_BMPFILE] = VT_STRING;
validAttributes[ATTR_SOUNDFILE] = VT_STRING;
validAttributes[ATTR_ALARMMESSAGE] = VT_STRING;
validAttributes[ATTR_ALARMAREALIST] = VT_STRING + VT_ARRAY;
validAttributes[ATTR_PRIMALARMAREA] = VT_STRING;
validAttributes[ATTR_CONDLOGIC] = VT_STRING;
validAttributes[ATTR_LIMITEXCEEDED] = VT_STRING;
validAttributes[ATTR_DEADBAND] = VT_R8;
validAttributes[ATTR_HIHILIMIT] = VT_R8;
validAttributes[ATTR_HILIMIT] = VT_R8;
validAttributes[ATTR_LOLIMIT] = VT_R8;
validAttributes[ATTR_LOLOLIMIT] = VT_R8;
validAttributes[ATTR_RATECHANGELIMIT] = VT_R8;
validAttributes[ATTR_DEVIATIONLIMIT] = VT_R8;
validAttributes[ATTR_WATCHLIMIT] = VT_BOOL;
validAttributes[ATTR_DESCRIPTION] = VT_STRING;
validAttributes[ATTR_CONQUALITY] = VT_I2;
validAttributes[ATTR_FORMAT] = VT_STRING;
validAttributes[ATTR_MASKED] = VT_BOOL;
validAttributes[ATTR_DTYPE] = VT_UI1;
validAttributes[ATTR_SYSM] = VT_UI1;
validAttributes[ATTR_ALARMID] = VT_I4 + VT_ARRAY;
validAttributes[ATTR_DEVICE] = VT_UI1;
validAttributes[ATTR_USERTAG] = VT_STRING;
validAttributes[ATTR_SIGNIFICATION] = VT_UI1;
validAttributes[ATTR_NAMUR] = VT_BOOL;
validAttributes[ATTR_TAMPER] = VT_BOOL;
validAttributes[ATTR_VALUECHEXPRESSION] = VT_STRING;
validAttributes[ATTR_BESTRECEIVER] = VT_UI2;
validAttributes[ATTR_BESTREPEATER] = VT_UI4;
validAttributes[ATTR_STORAGENUMBER] = VT_UI4;
validAttributes[ATTR_TARIFNUMBER] = VT_UI4;
validAttributes[ATTR_UNITNUMBER] = VT_UI4;
/**
* Канал сервера
* @typedef {Object} Channel2
* @property {string} name - наименование
* @property {number} number - числовой идентификатор на сервере
* @property {number} type - тип
* @property {*} value - значение
* @property {number} quality - качество
* @property {Date} dt - время изменения
* @property {boolean} needRegister - необходимо зарегистрировать
* @property {boolean} needSend - необходимо передать
* @property {boolean} active - активен
* @property {boolean} writeEnable - разрешение записи
* @property {boolean} saveServer - сохранять значение на сервере при откоючении источника
* @property {Object.<number, Attribute>} attributes - массив атрибутов
* @property {number} [creator] - идентификатор создателя канала
* @property {number} [owner] - источник значения для канала
* @property {number} [groups] - принадлежность группам каналов
*/
/**
* Атрибут канала
* @typedef {Object} Attribute
* @property {number} id - идентификатор
* @property {*} value - значение
* @property {Date} dt - дата изменения
* @property {boolean} fromServer - получен от сервера
*/
/**
* Структура данных управления каналом
* @typedef {Object} Control
* @property {string} name - имя канала для которого пришла команда управления
* @property {*} value - полученное значение команды
* @property {Date} dt - метка времени
*/
/**
* Значение переменного типа
* @private
* @typedef {Object} VarType
* @property {(number|string|boolean|number[]|string[]|boolean[])} value - значение
* @property {number} type - тип
* @property {number} size - размер
*/
/**
* Параметры подключения к серверу
* @typedef {Object} ConnectOptions
* @property {string} host - адрес сервера
* @property {number} port - номер TCP порта
* @property {string} login - логин
* @property {string} password - пароль
* @property {boolean} reconnect - автоматически переподключаться при ошибках и разрывах связи
* @property {boolean} opros - тип учетной записи "опрос"
* @property {boolean} client - тип учетной записи "клиент"
*/
/**
* Параметры задаваемые при создании канала
* @typedef {Object} ChannelOptions
* @property {string} [units] - единицы измерения
* @property {string} [comment] - текстовое описание
* @property {number} [signification] - назначение
* @property {boolean} [saveValue] - сохранять значение на сервере при отключении опросчика
* @property {Array.<string>} [enum] - массив строк, соответствующих значению канала
* @property {Array.<number>} [bounds] - массив из двух элементов [нижняя граница, верхняя граница]
* @property {number} [percentDeadband] - величина "мертвой зоны" изменения значения канала в процентах
*/
const win1251Map = {0: 0, 1: 1, 2: 2, 3: 3, 4: 4, 5: 5, 6: 6, 7: 7, 8: 8, 9: 9, 10: 10, 11: 11, 12: 12, 13: 13, 14: 14, 15: 15, 16: 16, 17: 17, 18: 18, 19: 19, 20: 20, 21: 21, 22: 22, 23: 23, 24: 24, 25: 25, 26: 26, 27: 27, 28: 28, 29: 29, 30: 30, 31: 31, 32: 32, 33: 33, 34: 34, 35: 35, 36: 36, 37: 37, 38: 38, 39: 39, 40: 40, 41: 41, 42: 42, 43: 43, 44: 44, 45: 45, 46: 46, 47: 47, 48: 48, 49: 49, 50: 50, 51: 51, 52: 52, 53: 53, 54: 54, 55: 55, 56: 56, 57: 57, 58: 58, 59: 59, 60: 60, 61: 61, 62: 62, 63: 63, 64: 64, 65: 65, 66: 66, 67: 67, 68: 68, 69: 69, 70: 70, 71: 71, 72: 72, 73: 73, 74: 74, 75: 75, 76: 76, 77: 77, 78: 78, 79: 79, 80: 80, 81: 81, 82: 82, 83: 83, 84: 84, 85: 85, 86: 86, 87: 87, 88: 88, 89: 89, 90: 90, 91: 91, 92: 92, 93: 93, 94: 94, 95: 95, 96: 96, 97: 97, 98: 98, 99: 99, 100: 100, 101: 101, 102: 102, 103: 103, 104: 104, 105: 105, 106: 106, 107: 107, 108: 108, 109: 109, 110: 110, 111: 111, 112: 112, 113: 113, 114: 114, 115: 115, 116: 116, 117: 117, 118: 118, 119: 119, 120: 120, 121: 121, 122: 122, 123: 123, 124: 124, 125: 125, 126: 126, 127: 127, 1027: 129, 8225: 135, 1046: 198, 8222: 132, 1047: 199, 1168: 165, 1048: 200, 1113: 154, 1049: 201, 1045: 197, 1050: 202, 1028: 170, 160: 160, 1040: 192, 1051: 203, 164: 164, 166: 166, 167: 167, 169: 169, 171: 171, 172: 172, 173: 173, 174: 174, 1053: 205, 176: 176, 177: 177, 1114: 156, 181: 181, 182: 182, 183: 183, 8221: 148, 187: 187, 1029: 189, 1056: 208, 1057: 209, 1058: 210, 8364: 136, 1112: 188, 1115: 158, 1059: 211, 1060: 212, 1030: 178, 1061: 213, 1062: 214, 1063: 215, 1116: 157, 1064: 216, 1065: 217, 1031: 175, 1066: 218, 1067: 219, 1068: 220, 1069: 221, 1070: 222, 1032: 163, 8226: 149, 1071: 223, 1072: 224, 8482: 153, 1073: 225, 8240: 137, 1118: 162, 1074: 226, 1110: 179, 8230: 133, 1075: 227, 1033: 138, 1076: 228, 1077: 229, 8211: 150, 1078: 230, 1119: 159, 1079: 231, 1042: 194, 1080: 232, 1034: 140, 1025: 168, 1081: 233, 1082: 234, 8212: 151, 1083: 235, 1169: 180, 1084: 236, 1052: 204, 1085: 237, 1035: 142, 1086: 238, 1087: 239, 1088: 240, 1089: 241, 1090: 242, 1036: 141, 1041: 193, 1091: 243, 1092: 244, 8224: 134, 1093: 245, 8470: 185, 1094: 246, 1054: 206, 1095: 247, 1096: 248, 8249: 139, 1097: 249, 1098: 250, 1044: 196, 1099: 251, 1111: 191, 1055: 207, 1100: 252, 1038: 161, 8220: 147, 1101: 253, 8250: 155, 1102: 254, 8216: 145, 1103: 255, 1043: 195, 1105: 184, 1039: 143, 1026: 128, 1106: 144, 8218: 130, 1107: 131, 8217: 146, 1108: 186, 1109: 190};
/**
* Преобразование строки UTF-8 в Windows-1251
* @private
* @param {string} s - исходная строка
* @returns {string}
*/
function utf8ToWin1251(s) {
var L = [];
for (var i=0; i < s.length; i++) {
var ord = s.charCodeAt(i);
if (ord in win1251Map) {
L.push(String.fromCharCode(win1251Map[ord]));
}
}
return L.join('');
}
var utf8Map = {0:'\u0402',1:'\u0403',2:'\u201A',3:'\u0453',4:'\u201E',5:'\u2026',6:'\u2020',7:'\u2021',8:'\u20AC',9:'\u2030',10:'\u0409',11:'\u2039',12:'\u040A',13:'\u040C',14:'\u040B',15:'\u040F',16:'\u0452',17:'\u2018',18:'\u2019',19:'\u201C',20:'\u201D',21:'\u2022',22:'\u2013',23:'\u2014',24:'\x98',25:'\u2122',26:'\u0459',27:'\u203A',28:'\u045A',29:'\u045C',30:'\u045B',31:'\u045F',32:'\xA0',33:'\u040E',34:'\u045E',35:'\u0408',36:'\xA4',37:'\u0490',38:'\xA6',39:'\xA7',40:'\u0401',41:'\xA9',42:'\u0404',43:'\xAB',44:'\xAC',45:'\xAD',46:'\xAE',47:'\u0407',48:'\xB0',49:'\xB1',50:'\u0406',51:'\u0456',52:'\u0491',53:'\xB5',54:'\xB6',55:'\xB7',56:'\u0451',57:'\u2116',58:'\u0454',59:'\xBB',60:'\u0458',61:'\u0405',62:'\u0455',63:'\u0457',64:'\u0410',65:'\u0411',66:'\u0412',67:'\u0413',68:'\u0414',69:'\u0415',70:'\u0416',71:'\u0417',72:'\u0418',73:'\u0419',74:'\u041A',75:'\u041B',76:'\u041C',77:'\u041D',78:'\u041E',79:'\u041F',80:'\u0420',81:'\u0421',82:'\u0422',83:'\u0423',84:'\u0424',85:'\u0425',86:'\u0426',87:'\u0427',88:'\u0428',89:'\u0429',90:'\u042A',91:'\u042B',92:'\u042C',93:'\u042D',94:'\u042E',95:'\u042F',96:'\u0430',97:'\u0431',98:'\u0432',99:'\u0433',100:'\u0434',101:'\u0435',102:'\u0436',103:'\u0437',104:'\u0438',105:'\u0439',106:'\u043A',107:'\u043B',108:'\u043C',109:'\u043D',110:'\u043E',111:'\u043F',112:'\u0440',113:'\u0441',114:'\u0442',115:'\u0443',116:'\u0444',117:'\u0445',118:'\u0446',119:'\u0447',120:'\u0448',121:'\u0449',122:'\u044A',123:'\u044B',124:'\u044C',125:'\u044D',126:'\u044E',127:'\u044F'};
/**
* Преобразование строки Windows-1251 в UTF-8
* @private
* @param {string} s - исходная строка
* @returns {string}
*/
function win1251toUtf8(s) {
var L = [];
for (let i = 0; i < s.length; i++) {
var ord = s.charCodeAt(i);
if (ord >= 128) {
ord = ord - 128;
if(ord in utf8Map) {
L.push(utf8Map[ord]);
}
} else {
L.push(String.fromCharCode(ord));
}
}
return L.join('');
}
/**
* Событие формируется при начале подключения к серверу.
* @event LMClient#connecting
* @property {string} host - адрес сервера к которому происходит подключение
* @property {number} port - номер TCP-порта сервера
*/
/**
* Событие формируется когда соединение с сервером установлено.
* @event LMClient#connect
*/
/**
* Событие формируется когда соединение с сервером разорвано.
* @event LMClient#disconnect
* @property {boolean} err - признак того, что соединение разорвано в результате ошибки
*/
/**
* Событие формируется когда клиент успешно зарегистрировался на сервере.
* @event LMClient#loggedIn
* @property {number} serverId - идентификатор клиента на сервере
* @property {string} version - версия сервера в формате "hi.lo"
*/
/**
* Событие формируется при успешном выполнении проверки связи с сервером.
* @event LMClient#checkConnection
* @property {number} delay - задержка в миллисекундах при ответе сервера на команду проверки связи
*
*/
/**
* Событие формируется при получении от сервера команды синхронизации времени.
* @event LMClient#timeSynchronize
* @property {Date} time - значение времени полученное от сервера
*/
/**
* Событие формируется при получении от сервера команды записи в канал управления. Для подтверждения получения и обработки этого события
* необходимо установить полученное значение канала вызовом setValue(name, value).
* @example
* client.on('control', function(control){
* console.log('receive control "' + control.name + '" value="' + control.value + '"');
* client.setValue(control.name, control.value); // подтверждаем прием
* });
* @event LMClient#control
* @property {Control} control - полученная команда управления каналом
*/
/**
* Событие формируется при получении клиентом от сервера нового значения канала. При отключении от сервера событие формируется для всех ранее полученных
* от него каналов с установленным свойством quality в значение stOff.
* Событие используется при работе в режиме учетной записи "клиент".
* @event LMClient#channel
* @property {Channel2} channel - объект состояние канала
*/
/**
* Уведомление о добавлении нового канала.
* Уведомление формируется только для учетных записей типа "клиент" в случае добавления нового канала другим клиентом сервера.
* Значение и метка времени канала сразу после его добавления не определено.
* @event LMClient#add
* @property {Channel2} channel - новый канал
*/
/**
* Уведомление о изменении настроек (свойств или атрибутов) канала.
* Измениться могут перечень и значения атрибутов, значения свойств active, writeEnable и saveServer.
* Изменение значения самого канала не приводит к появлению данного уведомления. Уведомление формируется
* только для учетных записей типа "клиент".
* @event LMClient#change
* @property {Channel2} channel - измененный канал
*/
/**
* Уведомление об удалении канала с именем "name" или его атрибута с идентификатором "attrId".
* Если аргумент "attrId" не определен, то событие сообщает об удалении канала "name".
* В противном случае событие сообщает об удалении атрибута "attrId".
* Уведомление формируется только для учетных записей типа "клиент".
* @example
* client.on('delete', function(name, attrId){
* if(attrId === undefined) console.log('channel "' + name + '" was removed');
* else console.log('attribute ' + attrId + ' was removed from channel "' + name + '" deleted');
* });
* @event LMClient#delete
* @property {string} name - имя канала
* @property {(number|undefined)} [attrId] - идентификатор атрибута
*/
/**
* Событие формируется для учетных записей типа "клиент" после подключения к серверу и запроса списка имеющихся каналов.
* @event LMClient#count
* @property {number} count - количество каналов
*/
/**
* Событие формируется при возникновении ошибки. Программа должна содержать обработчик этого события.
* @event LMClient#error
* @property {Error} error - ошибка
*/
/**
* @class Класс клиента сервера LM
* @fires LMClient#connecting
* @fires LMClient#connect
* @fires LMClient#disconnect
* @fires LMClient#loggedIn
* @fires LMClient#checkConnection
* @fires LMClient#timeSynchronize
* @fires LMClient#control
* @fires LMClient#channel
* @fires LMClient#add
* @fires LMClient#change
* @fires LMClient#delete
* @fires LMClient#count
* @fires LMClient#error
*/
class LMClient extends EventEmitter {
/**
* Конструктор класса.
* Создает новый экземпляр класса подключения к серверу. В параметрах конструктора указываются
* настройки используемые при подключении к серверу.
* @constructor
* @param {ConnectOptions} options Параметры подключения к серверу
*/
constructor(options = {}) {
super();
//
this.options = Object.assign({}, {
host: '127.0.0.1', // адрес сервера
port: 3000, // порт сервера
login: '', // логин
password: '', // пароль
reconnect: true, // автоматически переподключаться при ошибках и разрывах связи
opros: true, // тип учетной записи "опрос"
client: false // тип учетной записи "клиент" (не поддерживается)
}, options);
//
this.socket = null;
/**
* приемный буфер
* @private
* @type {Buffer}
* */
this.inbuf = Buffer.allocUnsafe(0);
//
this.waitStatus = 0; // признак ожидания запрошенного статуса
/**
* Текущее состояние регистрации на сервере.
* Значение true соответствует тому, что клиент успешно подключен и зарегестрирован на сервере.
* @public
* @readonly
* @type {boolean}
*/
this.loggedIn = false; // клиент зарегистрирован на сервере
/**
* Текущее состояние подключения к серверу.
* Значение true соответствует тому, что клиент установил соединение с сервером. Состояние регистрации можно
* проконтролировать через свойство loggedIn.
* @public
* @readonly
* @type {boolean}
*/
this.connected = false;
this.serverVersion = 0; // версия сервера
this.serverTimeBias = 0; // смещение времени сервера
this.reconnectTimer = null; // таймер повторных соединений
this.checkConnTimer = null; // таймер проверки связи
/**
* Интервал проверки связи с сервером в мс.
* Значение по умолчанию 480000 мс (8 минут). Не рекомендуется устанавливать значение более 600000 мс (10 минут).
* @public
* @type {number}
*/
this.checkConnectInterval = 480000;
/**
* Список каналов. Элементы списка является экземплярами класса {@link Channel2}, ключом в списке являются имена каналов.
* Вы не должны напрямую изменять элементы списка! Для изменения используйте вызовы методов класса.
* @example
* // получение канала по имени
* channel = client.channelsMap.get('my_channel_name');
* // проверка на наличие канала
* if(client.channelsMap.has('my_channel_name')) {...}; else {...};
* // перебор всех каналов
* client.channelsMap.forEach(channel => {...});
* // получение количества каналов
* let count = client.channelsMap.size;
* @public
* @readonly
* @type {Map<string,Channel2>}
*/
this.channelsMap = new Map();
/**
* ассоциативный массив номеров каналов на сервере
* @private
* @type {Object.<number, string>}
*/
this.channelsNumbers = {};
}
/**
* Подключение и регистрация на сервере LM.
* Метод начинает процедуру подключения и регистрации к серверу системы LanMon. При подключении используются
* параметры указанные при создании класса. Если в параметрах указано значение reconnect: true, то соединение
* будет автоматически восстанавливаться в случаях обрыва связи или ошибок.
* @public
*/
connect() {
var _this = this;
//
this.socket = new net.Socket();
this.emit('connecting', this.options.host, this.options.port);
this.socket.connect(this.options.port, this.options.host, function (){
// соединение установлено
_this.connected = true;
_this.emit('connect');
// отправка данных регистрации
_this._sendRegisterStruct();
});
this.socket.on('error', function(err){
// ошибка при соединении или в процессе работы
_this.emit('error', err);
_this._disconnect();
});
this.socket.on('data', data => this._onReceiveData(data));
this.socket.on('close', function(err){
// соединение разорвано сервером
_this.emit('disconnect', err);
if(_this.connected) {
_this._disconnect();
}
});
}
/**
* Отключиться от сервера.
* Метод разрывает соединение с сервером если оно было ранее установлено вызовом метода connect().
* @public
*/
disconnect() {
this.connected = false;
this.loggedIn = false;
this.waitStatus = 0;
// сброс таймера перепоключений
if(this.reconnectTimer) {
clearTimeout(this.reconnectTimer);
this.reconnectTimer = null;
}
// сброс таймера проверки связи
if(this.checkConnTimer) {
clearInterval(this.checkConnTimer);
this.checkConnTimer = null;
}
// сброс состояния каналов
this.channelsMap.forEach(channel => {
if('creator' in channel) {
// канал полученный от сервера в режиме "клиент"
if(channel.quality !== stOff) {
channel.quality = stOff;
this.emit('channel', channel);
}
} else {
// канал созданный мной
channel.needRegister = true;
channel.needSend = ('value' in channel);
channel.active = false;
channel.number = -1;
}
});
// сброс номеров каналов
this.channelsNumbers = {};
// закрытие сокета
this.socket.destroy();
// сброс приемного буфера
this._truncateInBuf();
}
/**
* Добавление нового канала.
* Метод добавляет новый канал для регистрации и передачи данных на сервер.
* Метод используется при подключении с типом учетной записи "опрос".
* Метод может быть вызван при любом состоянии подключения к сервреру.
* Метод возвращает значение false если канал с указанным именем уже существует или
* если указан некорректный тип данных.
* @public
* @param {string} name Имя канала
* @param {number} type Тип канала
* @param {boolean} writeEnable Разрешение записи значений
* @param {ChannelOptions} options Параметры канала
* @returns {boolean}
*/
add(name, type, writeEnable, options = {}) {
// добавление каналов только в режиме опрос
if(!this.options.opros) {
return false;
}
// проверка на корректность типа данных
if(!validTypes.includes(type & VT_MASK)) {
return false;
}
// проверка на дублирование имени
if(this.channelsMap.has(name)) {
return false;
}
// создаем канал
/** @type {Channel2} */
var channel = {
'name': name,
'type': type,
'dt': new Date(),
'needRegister': true,
'needSend': false,
'active': false,
'writeEnable': writeEnable || false,
'saveServer': options.saveValue || false,
'number': -1,
'attributes': {}
};
// добавляем атрибуты
if(typeof options.units === 'string') {
channel.attributes[ATTR_UNITS] = this._createAttribute(ATTR_UNITS, options.units);
}
if(typeof options.comment === 'string') {
channel.attributes[ATTR_COMMENT] = this._createAttribute(ATTR_COMMENT, options.comment);
}
if(typeof options.signification === 'number') {
channel.attributes[ATTR_SIGNIFICATION] = this._createAttribute(ATTR_SIGNIFICATION, options.signification);
}
if(('bounds' in options) && Array.isArray(options.bounds)) {
channel.attributes[ATTR_EUType] = this._createAttribute(ATTR_EUType, 1);
channel.attributes[ATTR_EUInfo1] = this._createAttribute(ATTR_EUInfo1, options.bounds);
} else
if(('enum' in options) && Array.isArray(options.enum)) {
channel.attributes[ATTR_EUType] = this._createAttribute(ATTR_EUType, 2);
channel.attributes[ATTR_EUInfo2] = this._createAttribute(ATTR_EUInfo2, options.enum);
}
if('percentDeadband' in options) {
channel.attributes[ATTR_PERCENTDB] = this._createAttribute(ATTR_PERCENTDB, options.percentDeadband);
}
// добавляем канал
this.channelsMap.set(name, channel);
// передача на сервер
if(this.loggedIn) this._sendAll();
//
return true;
}
/**
* Удаление канала.
* Метод выполняет передачу на сервер запроса на удаление канала с указанным именем.
* При вызове метода клиент должен быть подключен и зарегистрирован на сервере.
* При наличии соотвествующих прав доступа клиента, сервер выполняет удаление соответствующей сущности и рассылет уведомления всем
* подключенным к нему клиентам, в том числе и вам. При наличии прав доступа, через некоторое время после вызова метода, клиент получит
* уведомление {@link #LMClient+event_delete "delete"}.
* Метод используется при подключении с типом учетной записи "клиент". При отсутствии указанного канала, неверном типе учетной записи или
* отсутствии регистрации на сервере метод возвращает значение false.
* @example
* // удаление канала 'myChannel'
* client.delete('myChannel');
* @public
* @param {string} name Имя канала
* @returns {boolean}
*//**
* Удаление атрибута канала.
* Метод выполняет передачу на сервер запроса на удаление атрибута с идентификатором attrId у канала с именем name.
* При вызове метода клиент должен быть подключен и зарегистрирован на сервере.
* При наличии соотвествующих прав доступа клиента, сервер выполняет удаление соответствующей сущности и рассылет уведомления всем
* подключенным к нему клиентам, в том числе и вам. При наличии прав доступа, через некоторое время после вызова метода, клиент получит
* уведомление {@link #LMClient+event_delete "delete"}.
* Метод используется при подключении с типом учетной записи "клиент". При отсутствии указанного канала, неверном типе учетной записи или
* отсутствии регистрации на сервере метод возвращает значение false.
* @example
* // удаление атрибута с идентификатором 100 к канала 'myChannel'
* client.delete('myChannel', 100);
* @public
* @param {string} name Имя канала
* @param {number} attrId Идентификатор атрибута
* @returns {boolean}
*/
delete(name, attrId) {
// проверка регистрации и типа подключения
if(!(this.loggedIn && this.options.client)) {
return false;
}
// проверка на наличие канала
let channel = this.channelsMap.get(name);
if(!channel) {
return false;
}
//
let buf = Buffer.allocUnsafe(13);
// Cmd UI1 66
// eslint-disable-next-line no-unused-vars
let offset = buf.writeUInt8(66, 0);
// Size UI2 13
offset = buf.writeUInt16LE(13, offset);
// Flag UI1 00000001
offset = buf.writeUInt8(1, offset);
// Number UI4
offset = buf.writeUInt32LE(channel.number, offset);
// ActionType UI1
if(typeof attrId === 'undefined') {
// удаляю канал
offset = buf.writeUInt8(1, offset);
offset = buf.writeUInt32LE(0, offset);
} else {
// проверка наличия атрибута
if(!(attrId in channel.attributes)) return false;
// удаляю атрибут
offset = buf.writeUInt8(2, offset);
offset = buf.writeUInt32LE(attrId, offset);
}
// передача
this.socket.write(buf);
return true;
}
/**
* Установка значения канала.
* Метод устанавливает значение для ранее созданного канала. Тип и значение параметра value должен соответствовать типу
* канала указанному при его создании. Установленное значение канала будет передано на сервер. Кроме того, метод
* устанавливает свойство канала quality (качество) в значение stOk. Метод используется при подключении с
* типом учетной записи "опрос". Метод может быть вызван при любом состоянии подключения к сервреру.
* Метод возвращает значение false если канал с указанным именем не найден или указан некорректный тип учетной записи.
* @public
* @param {string} name Имя канала
* @param {*} value Новое значение канала
* @returns {boolean}
*/
setValue(name, value) {
// установка значения только в режиме опрос
if(!this.options.opros) {
return false;
}
// проверка на наличие канала
let channel = this.channelsMap.get(name);
if(!channel) return false;
// проверка типа и значения
if(!this._checkValue(value, channel.type)) {
return false;
}
// проверка на изменения
if((channel.quality === stOk) && (channel.value === value)) {
return true;
}
// фильтрация значений с плавающей точкой
try {
if(((channel.type === VT_R4)||(channel.type === VT_R8))&&(channel.quality === stOk)&&(ATTR_PERCENTDB in channel.attributes)) {
if((ATTR_EUType in channel.attributes)&&(channel.attributes[ATTR_EUType].value === 1)&&(ATTR_EUInfo1 in channel.attributes)) {
// верхний и нижний диапазоны заданы
let minmax = channel.attributes[ATTR_EUInfo1].value;
if(Math.abs(channel.value - value) < Math.abs(minmax[0] - minmax[1])/100 * channel.attributes[ATTR_PERCENTDB].value) {
return true;
}
} else {
// верхний и нижний диапазоны не заданы
if(Math.abs(channel.value - value) < Math.abs(channel.value/100 * channel.attributes[ATTR_PERCENTDB].value)) {
return true;
}
}
}
} catch(err) {
// empty
}
// устанавливаем новое значение
channel.value = value;
channel.quality = stOk;
channel.dt = new Date();
channel.needSend = true;
// передача на сервер
if(this.loggedIn) this._sendAll();
//
return true;
}
/**
* Установка качества канала.
* Метод устанавливает значение свойства качество для ранее созданного канала. Метод используется при подключении с
* типом учетной записи "опрос". Значение качества канала stOk автоматически устанавливается при установке
* значения канала методом ```setValue(name, value)``` и отдельно устанавливать его не требуется.
* Метод может быть вызван при любом состоянии подключения к сервреру.
* Метод возвращает значение false если канал с указанным именем не найден, указано некорректное значение качества или
* тип учетной записи.
* @public
* @param {string} name Имя канала
* @param {number} quality Новое значение качества
* @returns {boolean}
*/
setQuality(name, quality) {
// качество stOk устанавливать нельзя, вместо этого нужно установить значение канала
if(quality === stOk) return false;
// проверка на наличие канала
let channel = this.channelsMap.get(name);
if(!channel) return false;
//
if(channel.quality === quality) return true;
//
channel.quality = quality;
channel.dt = new Date();
channel.needSend = true;
// передача на сервер
if(this.loggedIn) this._sendAll();
//
return true;
}
/**
* Формирование команды управления каналом.
* Метод используется при подключении с типом учетной записи "клиент".
* Для выполнения управления каналом должны выполняться следующие условия: клиент должен быть подключен и зарегистрирован на сервере,
* канал должен быть существующим, канал должен быть создан другим клиентом (опросчиком), у канала должны быть установлены признаки
* активности и разрешения записи значений, тип значения value должен быть совместим с типом канала.
* При выполнении перечисленных выше условий метод возвращает true, иначе - false.
* Метод не устанавливает значение канала, полученную команду управления сервер пересылает клиенту типа "опрос", который сформировал этот канал.
* @public
* @param {string} name Имя канала
* @param {*} value Значение команды управления
* @return {boolean}
*/
sendControl(name, value) {
if(!(this.options.client && this.loggedIn)) return false;
// Cmd UI1 55
// Size UI2
// Flag UI1
// Number UI4
// TimeStamp R8
// Quality UI1
// Type UI2
// Value VARTYPE
let channel = this.channelsMap.get(name);
if(!(channel && channel.active && channel.writeEnable && ('creator' in channel))) return false;
// проверка типа и значения
if(!this._checkValue(value, channel.type)) return false;
//
var buf = Buffer.allocUnsafe(4096);
// Cmd UI1 55
let offset = buf.writeUInt8(55, 0);
// Size UI2 пока пропускаем
offset += 2;
// Flag UI1 00001101
offset = buf.writeUInt8(13, offset);
// Number UI4
offset = buf.writeUInt32LE(channel.number, offset);
// TimeStamp R8
offset = buf.writeDoubleLE(this._dateToDateTime(new Date()), offset);
// Quality UI1
offset = buf.writeUInt8(stOk, offset);
// Type UI2
// Value VARTYPE
offset += this._writeVarTypeValue(value, channel.type).copy(buf, offset);
// Size UI2
buf.writeUInt16LE(offset, 1);
// передача
this.socket.write(buf.slice(0, offset));
// успешно
return true;
}
/**
* Отключение от сервера с последующим возможным повторным подключением
* @private
*/
_disconnect() {
this.disconnect();
//
if(this.options.reconnect) {
this.reconnectTimer = setTimeout(() => this.connect(), 10000);
}
}
/**
* Пришли данные от сервера
* @private
* @param {Buffer} data - буфер с данными
*/
_onReceiveData(data) {
// что-то пришло от сервера
// добавляем принятые данные в глобальный буфер
this.inbuf = Buffer.concat([this.inbuf, data]);
// указатель на начало очередной структуры
let offset = 0;
// цикл обработки структур
for(;;) {
if(this.inbuf.length <= offset) {
// в буфере ничего нового нет
this._truncateInBuf(offset);
return;
}
// читаем команду
let cmd = this.inbuf.readUInt8(offset);
// определяем размер структуры
let size = this._structSize(cmd);
if(size === 0) {
// размер структуры присутствует в самой структуре
if(this.inbuf.length < offset + 3) {
this._truncateInBuf(offset);
return;
}
// размер структуры
size = this.inbuf.readUInt16LE(offset + 1);
}
// проверка наличия в буфере очередной структуры ЦЕЛИКОМ
if(this.inbuf.length < offset + size) {
this._truncateInBuf(offset);
return;
}
// в буфере есть очередная структура ЦЕЛИКОМ
// console.log('receive cmd:' + cmd + ' size:' + size);
try {
this._parseCommand(this.inbuf, cmd, offset);
// выполнение разбора буфера может вызвать отключение от сервера, проверяем статус подключения
if(!this.connected) return;
} catch(error) {
this.emit('error', new Error('ошибка при разборе полученной структуры ' + cmd), error);
// this._disconnect();
}
// перенос указателя на начало следующей структуры
offset += size;
}
}
/**
* Обрезание обработанных команд во входном буфере.
* Если параметр offset не указан, то сбрасывает размер буфера до 0.
* @private
* @param {number} [offset] - смещение не обработанных команд
*/
_truncateInBuf(offset) {
if(typeof offset === 'undefined') {
offset = this.inbuf.length;
}
if(this.inbuf.length > 0) {
this.inbuf = this.inbuf.slice(offset);
}
}
/**
* Разбор очередной принятой структуры
* @private
* @param {Buffer} data - буфер с данными структуры
* @param {number} cmd - команда (она же находится в буфере по смещению offset)
* @param {number} offset - смещение в буфере
*/
_parseCommand(data, cmd, offset) {
// пропускаем поле команды
offset++;
//
switch(cmd) {
case 2:
// старый ответ на регистрацию
break;
case 7:
// конфигурация A1
break;
case 8:
// конфигурация A2
break;
case 9:
// конфигурация A3
break;
case 10:
// конфигурация A4 старая
break;
case 20:
// информация о состоянии канала 1
break;
case 21:
// управление каналом 1
break;
case 22: {
// синхронизация времени
// ServerTime VT_DATE
let serverDateTime = data.readDoubleLE(offset);
// Reserved VT_UI1[6]
this.emit('timeSynchronize', this._dateTimeToDate(serverDateTime));
break;
}
case 23:
// извещение клиентам
// Message VT_UI1
// Reserved VT_UI1[3]
break;
case 34:
// конфигурация A4 новая
break;
case 43: {
// ответ на регистрацию клиента
// Id VT_I4
let clientId = data.readInt32LE(offset);
offset += 4;
// Reserved1 VT_UI1
offset++;
// ServerTime VT_DATE
let serverDateTime = data.readDoubleLE(offset);
offset += 8;
// HiVer VT_UI1
let hiVer = data.readUInt8(offset++);
// LoVer VT_UI1
let loVer = data.readUInt8(offset++);
// Reserved2 VT_UI2
// Reserved3 VT_UI2
offset += 4;
// RefusalReason VT_UI1
let refusalReason = data.readUInt8(offset++);
// ServerTimeBias VT_I2
this.serverTimeBias = data.readInt16LE(offset);
offset += 2;
// Reserved4 VT_UI2
offset += 2;
// разбор
if(refusalReason === 0) {
// регистрация успешна
this.loggedIn = true;
this.emit('loggedIn', clientId, hiVer.toString(10) + '.' + loVer.toString(10));
this.emit('timeSynchronize', this._dateTimeToDate(serverDateTime));
// установка таймера проверки соединения
this.checkConnTimer = setInterval(() => this._checkConnection(), this.checkConnectInterval);
//
if(this.options.client) {
// запрос всех каналов
this._sendRequestAllChannels();
}
// передача каналов на сервер
this._sendAll();
} else {
// отказ в регистрации
let msg;
switch(refusalReason) {
case 1:
msg = 'тип учетной записи на сервере не совпадает с запрошенным';
break;
case 2:
msg = 'учетная запись уже подключена с другого адреса';
break;
case 3:
msg = 'ресурсы учетной записи заняты';
break;
case 4:
msg = 'неверный логин или пароль';
break;
default:
msg = 'ошибка ' + refusalReason + 'при регистрации на сервере';
}
this.emit('error', new Error(msg));
this._disconnect();
}
break;
}
case 53: {
// ответ на запрос всех каналов (получение количествоа каналов)
// Size VT_UI2
// let size = data.readUInt16LE(offset);
offset += 2;
let tagCount = data.readUInt32LE(offset);
offset += 4;
this.emit('count', tagCount);
break;
}
case 54: {
// ответ на запрос всех каналов (продолжение)
/** @type {Channel2} */
let channel = this._createEmptyChannel();
// Size VT_UI2
// let size = data.readUInt16LE(offset);
offset += 2;
// Flags VT_UI1 флаги
let flags = data.readUInt8(offset++);