-
Notifications
You must be signed in to change notification settings - Fork 331
/
DCCppMessage.java
3036 lines (2735 loc) · 109 KB
/
DCCppMessage.java
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
package jmri.jmrix.dccpp;
import java.util.concurrent.Delayed;
import java.util.concurrent.TimeUnit;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
/**
* Represents a single command or response on the DCC++.
* <p>
* Content is represented with ints to avoid the problems with sign-extension
* that bytes have, and because a Java char is actually a variable number of
* bytes in Unicode.
*
* @author Bob Jacobsen Copyright (C) 2002
* @author Paul Bender Copyright (C) 2003-2010
* @author Mark Underwood Copyright (C) 2015
* @author Costin Grigoras Copyright (C) 2018
* @author Harald Barth Copyright (C) 2019
*
* Based on XNetMessage by Bob Jacobsen and Paul Bender
*/
/*
* A few words on implementation:
*
* DCCppMessage objects are (usually) created by calling one of the static makeMessageType()
* methods, and are then consumed by the TrafficController/Packetizer by being converted to
* a String and sent out the port.
* <p>
* Internally the DCCppMessage is actually stored as a String, and alongside that is kept
* a Regex for easy extraction of the values where needed in the code.
* <p>
* The various getParameter() type functions are mainly for convenience in places such as the
* port monitor where we want to be able to extract the /meaning/ of the DCCppMessage and
* present it in a human readable form. Using the getParameterType() methods insulates
* the higher level code from needing to know what order/format the actual message is
* in.
*/
public class DCCppMessage extends jmri.jmrix.AbstractMRMessage implements Delayed {
private static int _nRetries = 3;
/* According to the specification, DCC++ has a maximum timing
interval of 500 milliseconds during normal communications */
protected static final int DCCppProgrammingTimeout = 10000; // TODO: Appropriate value for DCC++?
private static int DCCppMessageTimeout = 5000; // TODO: Appropriate value for DCC++?
//private ArrayList<Integer> valueList = new ArrayList<>();
private StringBuilder myMessage;
private String myRegex;
private char opcode;
/**
* Create a new object, representing a specific-length message.
*
* @param len Total bytes in message, including opcode and error-detection
* byte.
*/
//NOTE: Not used anywhere useful... consider removing.
public DCCppMessage(int len) {
super(len);
setBinary(false);
setRetries(_nRetries);
setTimeout(DCCppMessageTimeout);
if (len > DCCppConstants.MAX_MESSAGE_SIZE || len < 0) {
log.error("Invalid length in ctor: {}", len);
}
_nDataChars = len;
myRegex = "";
myMessage = new StringBuilder(len);
}
/**
* Create a new object, that is a copy of an existing message.
*
* @param message existing message.
*/
public DCCppMessage(DCCppMessage message) {
super(message);
setBinary(false);
setRetries(_nRetries);
setTimeout(DCCppMessageTimeout);
myRegex = message.myRegex;
myMessage = message.myMessage;
toStringCache = message.toStringCache;
}
/**
* Create an DCCppMessage from an DCCppReply.
* Not used. Really, not even possible. Consider removing.
* @param message existing reply to replicate.
*/
public DCCppMessage(DCCppReply message) {
super(message.getNumDataElements());
setBinary(false);
setRetries(_nRetries);
setTimeout(DCCppMessageTimeout);
for (int i = 0; i < message.getNumDataElements(); i++) {
setElement(i, message.getElement(i));
}
}
/**
* Create a DCCppMessage from a String containing bytes.
* <p>
* Since DCCppMessages are text, there is no Hex-to-byte conversion.
* <p>
* NOTE 15-Feb-17: un-Deprecating this function so that it can be used in
* the DCCppOverTCP server/client interface.
* Messages shouldn't be parsed, they are already in DCC++ format,
* so we need the string constructor to generate a DCCppMessage from
* the incoming byte stream.
* @param s message in string form.
*/
public DCCppMessage(String s) {
setBinary(false);
setRetries(_nRetries);
setTimeout(DCCppMessageTimeout);
myMessage = new StringBuilder(s); // yes, copy... or... maybe not.
toStringCache = s;
// gather bytes in result
setRegex();
_nDataChars = myMessage.length();
_dataChars = new int[_nDataChars];
}
// Partial constructor used in the static getMessageType() calls below.
protected DCCppMessage(char c) {
setBinary(false);
setRetries(_nRetries);
setTimeout(DCCppMessageTimeout);
opcode = c;
myMessage = new StringBuilder(Character.toString(c));
_nDataChars = myMessage.length();
}
protected DCCppMessage(char c, String regex) {
setBinary(false);
setRetries(_nRetries);
setTimeout(DCCppMessageTimeout);
opcode = c;
myRegex = regex;
myMessage = new StringBuilder(Character.toString(c));
_nDataChars = myMessage.length();
}
/**
* Parse a string and generate/return a DCCppMessage object.
*
* @param s String of DCC++ message without the {@literal < >} brackets
* @return DCCppMessage
*/
public static DCCppMessage parseDCCppMessage(String s) {
// Need to parse the string and construct a message from it.
Matcher m;
switch (s.charAt(0)) {
case DCCppConstants.ACCESSORY_CMD:
if ((m = match(s, DCCppConstants.ACCESSORY_CMD_REGEX, "ctor")) != null) {
int addr = Integer.parseInt(m.group(1));
int sub = Integer.parseInt(m.group(2));
int v = (m.group(3).equals("0") ? 0 : 1);
return (DCCppMessage.makeAccessoryDecoderMsg(addr, sub, (v == 1)));
} else {
return (null);
}
case DCCppConstants.CLEAR_EEPROM_CMD:
return (new DCCppMessage(DCCppConstants.CLEAR_EEPROM_CMD, DCCppConstants.CLEAR_EEPROM_REGEX));
case DCCppConstants.FUNCTION_CMD:
break;
case DCCppConstants.FUNCTION_V2_CMD:
if ((m = match(s, DCCppConstants.FUNCTION_V2_CMD_REGEX, "ctor")) != null) {
int cab = Integer.parseInt(m.group(1));
int func = Integer.parseInt(m.group(2));
int state = Integer.parseInt(m.group(3));
return (DCCppMessage.makeFunctionV2Message(cab, func, state));
} else {
return (null);
}
case DCCppConstants.FORGET_CAB_CMD:
if ((m = match(s, DCCppConstants.FORGET_CAB_CMD_REGEX, "ctor")) != null) {
int cab;
if (m.group(1).equals("")) { //no cab entered, forget all
cab = 0;
} else {
cab = Integer.parseInt(m.group(1));
}
return (DCCppMessage.makeForgetCabMessage(cab));
} else {
return (null);
}
case DCCppConstants.LIST_REGISTER_CONTENTS:
return (new DCCppMessage(DCCppConstants.LIST_REGISTER_CONTENTS, DCCppConstants.LIST_REGISTER_CONTENTS_REGEX));
case DCCppConstants.OPS_WRITE_CV_BIT:
if ((m = match(s, DCCppConstants.OPS_WRITE_BIT_REGEX, "ctor")) != null) {
int addr = Integer.parseInt(m.group(1));
int cv = Integer.parseInt(m.group(2));
int bit = Integer.parseInt(m.group(3));
int val = (m.group(4).equals("0") ? 0 : 1);
return (DCCppMessage.makeBitWriteOpsModeCVMsg(addr, cv, bit, val));
} else {
return (null);
}
case DCCppConstants.OPS_WRITE_CV_BYTE:
if ((m = match(s, DCCppConstants.OPS_WRITE_BYTE_REGEX, "ctor")) != null) {
int addr = Integer.parseInt(m.group(1));
int cv = Integer.parseInt(m.group(2));
int val = Integer.parseInt(m.group(3));
return (DCCppMessage.makeWriteOpsModeCVMsg(addr, cv, val));
} else {
return (null);
}
case DCCppConstants.PROG_READ_CV:
if ((m = match(s, DCCppConstants.PROG_READ_REGEX, "ctor")) != null) {
int cv = Integer.parseInt(m.group(1));
int cb = Integer.parseInt(m.group(2));
int cs = Integer.parseInt(m.group(3));
return (DCCppMessage.makeReadDirectCVMsg(cv, cb, cs));
} else {
return (null);
}
case DCCppConstants.PROG_VERIFY_CV:
if ((m = match(s, DCCppConstants.PROG_VERIFY_REGEX, "ctor")) != null) {
int cv = Integer.parseInt(m.group(1));
int sv = Integer.parseInt(m.group(2));
return (DCCppMessage.makeVerifyCVMsg(cv, sv));
} else {
return (null);
}
case DCCppConstants.PROG_WRITE_CV_BIT:
if ((m = match(s, DCCppConstants.PROG_WRITE_BIT_REGEX, "ctor")) != null) {
int cv = Integer.parseInt(m.group(1));
int bit = Integer.parseInt(m.group(2));
int val = (m.group(3).equals("0") ? 0 : 1);
int addr = Integer.parseInt(m.group(4));
int sub = Integer.parseInt(m.group(5));
return (DCCppMessage.makeBitWriteDirectCVMsg(cv, bit, val, addr, sub));
} else {
return (null);
}
case DCCppConstants.PROG_WRITE_CV_BYTE:
if ((m = match(s, DCCppConstants.PROG_WRITE_BYTE_REGEX, "ctor")) != null) {
int cv = Integer.parseInt(m.group(1));
int val = Integer.parseInt(m.group(2));
int addr = Integer.parseInt(m.group(3));
int sub = Integer.parseInt(m.group(4));
return (DCCppMessage.makeWriteDirectCVMsg(cv, val, addr, sub));
} else {
return (null);
}
case DCCppConstants.READ_CS_STATUS:
return (new DCCppMessage(DCCppConstants.READ_CS_STATUS, DCCppConstants.READ_CS_STATUS_REGEX));
case DCCppConstants.READ_MAXNUMSLOTS:
return (new DCCppMessage(DCCppConstants.READ_MAXNUMSLOTS, DCCppConstants.READ_MAXNUMSLOTS_REGEX));
case DCCppConstants.READ_TRACK_CURRENT:
return (DCCppMessage.makeReadTrackCurrentMsg());
case DCCppConstants.SENSOR_CMD:
if ((m = match(s, DCCppConstants.SENSOR_ADD_REGEX, "ctor")) != null) {
int id = Integer.parseInt(m.group(1));
int pin = Integer.parseInt(m.group(2));
int pullup = (m.group(4).equals("0") ? 0 : 1);
return (DCCppMessage.makeSensorAddMsg(id, pin, pullup));
} else if ((m = match(s, DCCppConstants.SENSOR_DELETE_REGEX, "ctor")) != null) {
int id = Integer.parseInt(m.group(1));
return (DCCppMessage.makeSensorDeleteMsg(id));
} else if ((match(s, DCCppConstants.SENSOR_LIST_REGEX, "ctor")) != null) {
return (new DCCppMessage(DCCppConstants.SENSOR_CMD, DCCppConstants.SENSOR_LIST_REGEX));
} else {
return (null);
}
case DCCppConstants.THROTTLE_CMD:
if ((m = match(s, DCCppConstants.THROTTLE_CMD_REGEX, "ctor")) != null) {
int reg = Integer.parseInt(m.group(1));
int addr = Integer.parseInt(m.group(2));
float speed = Float.parseFloat(m.group(3)); // Note: gets converted to int inside makeSpeedAndDirectionMsg()
int fwd = (m.group(4).equals("0") ? 0 : 1);
return (DCCppMessage.makeSpeedAndDirectionMsg(reg, addr, speed, (fwd == 1)));
} else {
return (null);
}
case DCCppConstants.TRACK_POWER_OFF:
return (DCCppMessage.makeTrackPowerOffMsg());
case DCCppConstants.TRACK_POWER_ON:
return (DCCppMessage.makeTrackPowerOnMsg());
case DCCppConstants.TURNOUT_CMD:
if ((m = match(s, DCCppConstants.TURNOUT_ADD_REGEX, "ctor")) != null) {
int id = Integer.parseInt(m.group(1));
int addr = Integer.parseInt(m.group(2));
int sub = Integer.parseInt(m.group(3));
return (DCCppMessage.makeTurnoutAddMsg(id, addr, sub));
} else if ((m = match(s, DCCppConstants.TURNOUT_DELETE_REGEX, "ctor")) != null) {
int id = Integer.parseInt(m.group(1));
return (DCCppMessage.makeTurnoutDeleteMsg(id));
} else if ((match(s, DCCppConstants.TURNOUT_LIST_REGEX, "ctor")) != null) {
return (new DCCppMessage(DCCppConstants.TURNOUT_CMD, DCCppConstants.TURNOUT_LIST_REGEX));
} else if ((m = match(s, DCCppConstants.TURNOUT_CMD_REGEX, "ctor")) != null) {
int id = Integer.parseInt(m.group(1));
int thrown = m.group(2).equals("0") ? 0 : 1;
return (DCCppMessage.makeTurnoutCommandMsg(id, (thrown == 1)));
} else {
return (null);
}
case DCCppConstants.OUTPUT_CMD:
if ((m = match(s, DCCppConstants.OUTPUT_CMD_REGEX, "ctor")) != null) {
int id = Integer.parseInt(m.group(1));
int state = m.group(2).equals("0") ? 0 : 1;
return (DCCppMessage.makeOutputCmdMsg(id, (state == 1)));
} else if ((m = match(s, DCCppConstants.OUTPUT_ADD_REGEX, "ctor")) != null) {
int id = Integer.parseInt(m.group(1));
int pin = Integer.parseInt(m.group(2));
int iflag = Integer.parseInt(m.group(3));
return (DCCppMessage.makeOutputAddMsg(id, pin, iflag));
} else if ((m = match(s, DCCppConstants.OUTPUT_DELETE_REGEX, "ctor")) != null) {
int id = Integer.parseInt(m.group(1));
return (DCCppMessage.makeOutputDeleteMsg(id));
} else if ((m = match(s, DCCppConstants.OUTPUT_LIST_REGEX, "ctor")) != null) {
return (DCCppMessage.makeOutputListMsg());
} else {
return (null);
}
case DCCppConstants.WRITE_DCC_PACKET_MAIN:
break;
case DCCppConstants.WRITE_DCC_PACKET_PROG:
break;
case DCCppConstants.WRITE_TO_EEPROM_CMD:
return (new DCCppMessage(DCCppConstants.WRITE_TO_EEPROM_CMD, DCCppConstants.WRITE_TO_EEPROM_REGEX));
case DCCppConstants.QUERY_SENSOR_STATES_CMD:
return (new DCCppMessage(DCCppConstants.QUERY_SENSOR_STATES_CMD, DCCppConstants.QUERY_SENSOR_STATES_REGEX));
default:
return (null);
}
return (null);
}
private void setRegex() {
switch (myMessage.charAt(0)) {
case DCCppConstants.THROTTLE_CMD:
myRegex = DCCppConstants.THROTTLE_CMD_REGEX;
break;
case DCCppConstants.FUNCTION_CMD:
myRegex = DCCppConstants.FUNCTION_CMD_REGEX;
break;
case DCCppConstants.FUNCTION_V2_CMD:
myRegex = DCCppConstants.FUNCTION_V2_CMD_REGEX;
break;
case DCCppConstants.FORGET_CAB_CMD:
myRegex = DCCppConstants.FORGET_CAB_CMD_REGEX;
break;
case DCCppConstants.ACCESSORY_CMD:
myRegex = DCCppConstants.ACCESSORY_CMD_REGEX;
break;
case DCCppConstants.TURNOUT_CMD:
if ((match(toString(), DCCppConstants.TURNOUT_ADD_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.TURNOUT_ADD_REGEX;
} else if ((match(toString(), DCCppConstants.TURNOUT_DELETE_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.TURNOUT_DELETE_REGEX;
} else if ((match(toString(), DCCppConstants.TURNOUT_LIST_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.TURNOUT_LIST_REGEX;
} else if ((match(toString(), DCCppConstants.TURNOUT_CMD_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.TURNOUT_CMD_REGEX;
} else {
myRegex = "";
}
break;
case DCCppConstants.SENSOR_CMD:
if ((match(toString(), DCCppConstants.SENSOR_ADD_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.SENSOR_ADD_REGEX;
} else if ((match(toString(), DCCppConstants.SENSOR_DELETE_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.SENSOR_DELETE_REGEX;
} else if ((match(toString(), DCCppConstants.SENSOR_LIST_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.SENSOR_LIST_REGEX;
} else {
myRegex = "";
}
break;
case DCCppConstants.OUTPUT_CMD:
if ((match(toString(), DCCppConstants.OUTPUT_ADD_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.OUTPUT_ADD_REGEX;
} else if ((match(toString(), DCCppConstants.OUTPUT_DELETE_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.OUTPUT_DELETE_REGEX;
} else if ((match(toString(), DCCppConstants.OUTPUT_LIST_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.OUTPUT_LIST_REGEX;
} else if ((match(toString(), DCCppConstants.OUTPUT_CMD_REGEX, "ctor")) != null) {
myRegex = DCCppConstants.OUTPUT_CMD_REGEX;
} else {
myRegex = "";
}
break;
case DCCppConstants.OPS_WRITE_CV_BYTE:
myRegex = DCCppConstants.OPS_WRITE_BYTE_REGEX;
break;
case DCCppConstants.OPS_WRITE_CV_BIT:
myRegex = DCCppConstants.OPS_WRITE_BIT_REGEX;
break;
case DCCppConstants.PROG_WRITE_CV_BYTE:
myRegex = DCCppConstants.PROG_WRITE_BYTE_REGEX;
break;
case DCCppConstants.PROG_WRITE_CV_BIT:
myRegex = DCCppConstants.PROG_WRITE_BIT_REGEX;
break;
case DCCppConstants.PROG_READ_CV:
myRegex = DCCppConstants.PROG_READ_REGEX;
break;
case DCCppConstants.PROG_VERIFY_CV:
myRegex = DCCppConstants.PROG_VERIFY_REGEX;
break;
case DCCppConstants.TRACK_POWER_ON:
case DCCppConstants.TRACK_POWER_OFF:
myRegex = DCCppConstants.TRACK_POWER_REGEX;
break;
case DCCppConstants.READ_TRACK_CURRENT:
myRegex = DCCppConstants.READ_TRACK_CURRENT_REGEX;
break;
case DCCppConstants.READ_CS_STATUS:
myRegex = DCCppConstants.READ_CS_STATUS_REGEX;
break;
case DCCppConstants.READ_MAXNUMSLOTS:
myRegex = DCCppConstants.READ_MAXNUMSLOTS_REGEX;
break;
case DCCppConstants.WRITE_TO_EEPROM_CMD:
myRegex = DCCppConstants.WRITE_TO_EEPROM_REGEX;
break;
case DCCppConstants.CLEAR_EEPROM_CMD:
myRegex = DCCppConstants.CLEAR_EEPROM_REGEX;
break;
case DCCppConstants.QUERY_SENSOR_STATES_CMD:
myRegex = DCCppConstants.QUERY_SENSOR_STATES_REGEX;
break;
case DCCppConstants.WRITE_DCC_PACKET_MAIN:
myRegex = DCCppConstants.WRITE_DCC_PACKET_MAIN_REGEX;
break;
case DCCppConstants.WRITE_DCC_PACKET_PROG:
myRegex = DCCppConstants.WRITE_DCC_PACKET_PROG_REGEX;
break;
case DCCppConstants.LIST_REGISTER_CONTENTS:
myRegex = DCCppConstants.LIST_REGISTER_CONTENTS_REGEX;
break;
case DCCppConstants.DIAG_CMD:
myRegex = DCCppConstants.DIAG_CMD_REGEX;
break;
default:
myRegex = "";
}
}
private String toStringCache = null;
/**
* Converts DCCppMessage to String format (without the {@code <>} brackets)
*
* @return String form of message.
*/
@Override
public String toString() {
if (toStringCache == null) {
toStringCache = myMessage.toString();
}
return toStringCache;
/*
String s = Character.toString(opcode);
for (int i = 0; i < valueList.size(); i++) {
s += " ";
s += valueList.get(i).toString();
}
return(s);
*/
}
/**
* Generate text translations of messages for use in the DCCpp monitor.
*
* @return representation of the DCCpp as a string.
*/
@Override
public String toMonitorString() {
// Beautify and display
String text;
switch (getOpCodeChar()) {
case DCCppConstants.THROTTLE_CMD:
text = "Throttle Cmd: ";
text += "Register: " + getRegisterString();
text += ", Address: " + getAddressString();
text += ", Speed: " + getSpeedString();
text += ", Direction: " + getDirectionString();
break;
case DCCppConstants.FUNCTION_CMD:
text = "Function Cmd: ";
text += "Address: " + getFuncAddressString();
text += ", Byte 1: " + getFuncByte1String();
text += ", Byte 2: " + getFuncByte2String();
text += ", (No Reply Expected)";
break;
case DCCppConstants.FUNCTION_V2_CMD:
text = "Function Cmd: ";
if (isFunctionV2Message()) {
text += "CAB: " + getFuncV2CabString();
text += ", FUNC: " + getFuncV2FuncString();
text += ", State: " + getFuncV2StateString();
text += ", (No Reply Expected)";
} else {
text += "Invalid syntax: '" + toString() + "'";
}
break;
case DCCppConstants.FORGET_CAB_CMD:
text = "Forget Cab: ";
if (isForgetCabMessage()) {
text += "CAB: " + (getForgetCabString().equals("")?"[ALL]":getForgetCabString());
text += ", (No Reply Expected)";
} else {
text += "Invalid syntax: '" + toString() + "'";
}
break;
case DCCppConstants.ACCESSORY_CMD:
text = "Accessory Decoder Cmd: ";
text += "Address: " + getAccessoryAddrString();
text += ", Subaddr: " + getAccessorySubString();
text += ", State: " + getAccessoryStateString();
break;
case DCCppConstants.TURNOUT_CMD:
if (isTurnoutAddMessage()) {
text = "Add Turnout: ";
text += "ID: " + getTOIDString();
text += ", Address: " + getTOAddressString();
text += ", Subaddr: " + getTOSubAddressString();
} else if (isTurnoutDeleteMessage()) {
text = "Delete Turnout: ";
text += "ID: " + getTOIDString();
} else if (isListTurnoutsMessage()) {
text = "List Turnouts...";
} else {
text = "Turnout Cmd: ";
text += "ID: " + getTOIDString();
text += ", State: " + getTOStateString();
}
break;
case DCCppConstants.OUTPUT_CMD:
if (isOutputCmdMessage()) {
text = "Output Cmd: ";
text += "ID: " + getOutputIDString();
text += ", State: " + getOutputStateString();
} else if (isOutputAddMessage()) {
text = "Add Output: ";
text += "ID: " + getOutputIDString();
text += ", Pin: " + getOutputPinString();
text += ", IFlag: " + getOutputIFlagString();
} else if (isOutputDeleteMessage()) {
text = "Delete Output: ";
text += "ID: " + getOutputIDString();
} else if (isListOutputsMessage()) {
text = "List Outputs...";
} else {
text = "Invalid Output Command: " + toString();
}
break;
case DCCppConstants.SENSOR_CMD:
if (isSensorAddMessage()) {
text = "Add Sensor: ";
text += "ID: " + getSensorIDString();
text += ", Pin: " + getSensorPinString();
text += ", Pullup: " + getSensorPullupString();
} else if (isSensorDeleteMessage()) {
text = "Delete Sensor: ";
text += "ID: " + getSensorIDString();
} else if (isListSensorsMessage()) {
text = "List Sensors...";
} else {
text = "Unknown Sensor Cmd...";
}
break;
case DCCppConstants.OPS_WRITE_CV_BYTE:
text = "Ops Write Byte Cmd: "; // <w cab cv val>
text += "Address: " + getOpsWriteAddrString() + ", ";
text += "CV: " + getOpsWriteCVString() + ", ";
text += "Value: " + getOpsWriteValueString();
break;
case DCCppConstants.OPS_WRITE_CV_BIT: // <b cab cv bit val>
text = "Ops Write Bit Cmd: ";
text += "Address: " + getOpsWriteAddrString() + ", ";
text += "CV: " + getOpsWriteCVString() + ", ";
text += "Bit: " + getOpsWriteBitString() + ", ";
text += "Value: " + getOpsWriteValueString();
break;
case DCCppConstants.PROG_WRITE_CV_BYTE:
text = "Prog Write Byte Cmd: ";
text += "CV : " + getCVString();
text += ", Value: " + getProgValueString();
text += ", Callback Num: " + getCallbackNumString();
text += ", Callback Sub: " + getCallbackSubString();
break;
case DCCppConstants.PROG_WRITE_CV_BIT:
text = "Prog Write Bit Cmd: ";
text += "CV : " + getCVString();
text += ", Bit : " + getBitString();
text += ", Value: " + getProgValueString();
text += ", Callback Num: " + getCallbackNumString();
text += ", Callback Sub: " + getCallbackSubString();
break;
case DCCppConstants.PROG_READ_CV:
text = "Prog Read Cmd: ";
text += "CV: " + getCVString();
text += ", Callback Num: " + getCallbackNumString();
text += ", Callback Sub: " + getCallbackSubString();
break;
case DCCppConstants.PROG_VERIFY_CV:
text = "Prog Verify Cmd: ";
text += "CV: " + getCVString();
text += ", startVal: " + getProgValueString();
break;
case DCCppConstants.TRACK_POWER_ON:
text = "Track Power ON Cmd ";
break;
case DCCppConstants.TRACK_POWER_OFF:
text = "Track Power OFF Cmd ";
break;
case DCCppConstants.READ_TRACK_CURRENT:
text = "Read Track Current Cmd ";
break;
case DCCppConstants.READ_CS_STATUS:
text = "Status Cmd ";
break;
case DCCppConstants.READ_MAXNUMSLOTS:
text = "Get MaxNumSlots Cmd ";
break;
case DCCppConstants.WRITE_DCC_PACKET_MAIN:
text = "Write DCC Packet Main Cmd: ";
text += "Register: " + getRegisterString();
text += ", Packet:" + getPacketString();
break;
case DCCppConstants.WRITE_DCC_PACKET_PROG:
text = "Write DCC Packet Prog Cmd: ";
text += "Register: " + getRegisterString();
text += ", Packet:" + getPacketString();
break;
case DCCppConstants.LIST_REGISTER_CONTENTS:
text = "List Register Contents Cmd: ";
text += toString();
break;
case DCCppConstants.WRITE_TO_EEPROM_CMD:
text = "Write to EEPROM Cmd: ";
text += toString();
break;
case DCCppConstants.CLEAR_EEPROM_CMD:
text = "Clear EEPROM Cmd: ";
text += toString();
break;
case DCCppConstants.QUERY_SENSOR_STATES_CMD:
text = "Query Sensor States Cmd: '" + toString() + "'";
break;
case DCCppConstants.DIAG_CMD:
text = "Diag Cmd: '" + toString() + "'";
break;
case DCCppConstants.ESTOP_ALL_CMD:
text = "eStop All Locos Cmd: '" + toString() + "'";
break;
default:
text = "Unknown Message: '" + toString() + "'";
}
return text;
}
@Override
public int getNumDataElements() {
return (myMessage.length());
// return(_nDataChars);
}
@Override
public int getElement(int n) {
return (this.myMessage.charAt(n));
}
@Override
public void setElement(int n, int v) {
// We want the ASCII value, not the string interpretation of the int
char c = (char) (v & 0xFF);
if (n >= myMessage.length()) {
myMessage.append(c);
} else if (n > 0) {
myMessage.setCharAt(n, c);
}
toStringCache = null;
}
// For DCC++, the opcode is the first character in the
// command (after the < ).
// note that the opcode is part of the message, so we treat it
// directly
// WARNING: use this only with opcodes that have a variable number
// of arguments following included. Otherwise, just use setElement
@Override
public void setOpCode(int i) {
if (i > 0xFF || i < 0) {
log.error("Opcode invalid: {}", i);
}
opcode = (char) (i & 0xFF);
myMessage.setCharAt(0, opcode);
toStringCache = null;
}
@Override
public int getOpCode() {
return (opcode & 0xFF);
}
public char getOpCodeChar() {
//return(opcode);
return (myMessage.charAt(0));
}
@Deprecated
public String getOpCodeString() {
return (Character.toString(opcode));
}
private int getGroupCount() {
Matcher m = match(toString(), myRegex, "gvs");
assert m != null;
return m.groupCount();
}
public String getValueString(int idx) {
Matcher m = match(toString(), myRegex, "gvs");
if (m == null) {
log.error("DCCppMessage '{}' not matched by '{}'", this.toString(), myRegex);
return ("");
} else if (idx <= m.groupCount()) {
return (m.group(idx));
} else {
log.error("DCCppMessage value index too big. idx = {} msg = {}", idx, this);
return ("");
}
}
public int getValueInt(int idx) {
Matcher m = match(toString(), myRegex, "gvi");
if (m == null) {
log.error("DCCppMessage '{}' not matched by '{}'", this.toString(), myRegex);
return (0);
} else if (idx <= m.groupCount()) {
return (Integer.parseInt(m.group(idx)));
} else {
log.error("DCCppMessage value index too big. idx = {} msg = {}", idx, this);
return (0);
}
}
public boolean getValueBool(int idx) {
log.debug("msg = {}, regex = {}", this, myRegex);
Matcher m = match(toString(), myRegex, "gvb");
if (m == null) {
log.error("DCCppMessage '{}' not matched by '{}'", this.toString(), myRegex);
return (false);
} else if (idx <= m.groupCount()) {
return (!m.group(idx).equals("0"));
} else {
log.error("DCCppMessage value index too big. idx = {} msg = {}", idx, this);
return (false);
}
}
/**
* @return the message length
*/
public int length() {
return (myMessage.length());
}
/**
* Change the default number of retries for an DCC++ message.
*
* @param t number of retries to attempt
*/
public static void setDCCppMessageRetries(int t) {
_nRetries = t;
}
/**
* Change the default timeout for a DCC++ message.
*
* @param t Timeout in milliseconds
*/
public static void setDCCppMessageTimeout(int t) {
DCCppMessageTimeout = t;
}
//------------------------------------------------------
// Message Helper Functions
// Core methods
/**
* Returns true if this DCCppMessage is properly formatted (or will generate
* a properly formatted command when converted to String).
*
* @return boolean true/false
*/
public boolean isValidMessageFormat() {
return this.match(this.myRegex) != null;
}
/**
* Matches this DCCppMessage against the given regex 'pat'
*
* @param pat Regex
* @return Matcher or null if no match.
*/
private Matcher match(String pat) {
return (match(this.toString(), pat, "Validator"));
}
/**
* matches the given string against the given Regex pattern.
*
* @param s string to be matched
* @param pat Regex string to match against
* @param name Text name to use in debug messages.
* @return Matcher or null if no match
*/
@CheckForNull
private static Matcher match(String s, String pat, String name) {
try {
Pattern p = Pattern.compile(pat);
Matcher m = p.matcher(s);
if (!m.matches()) {
log.trace("No Match {} Command: '{}' Pattern: '{}'", name, s, pat);
return null;
}
return m;
} catch (PatternSyntaxException e) {
log.error("Malformed DCC++ message syntax! s = {}", pat);
return (null);
} catch (IllegalStateException e) {
log.error("Group called before match operation executed string= {}", s);
return (null);
} catch (IndexOutOfBoundsException e) {
log.error("Index out of bounds string= {}", s);
return (null);
}
}
// Identity Methods
public boolean isThrottleMessage() {
return (this.getOpCodeChar() == DCCppConstants.THROTTLE_CMD);
}
public boolean isAccessoryMessage() {
return (this.getOpCodeChar() == DCCppConstants.ACCESSORY_CMD);
}
public boolean isFunctionMessage() {
return (this.getOpCodeChar() == DCCppConstants.FUNCTION_CMD);
}
public boolean isFunctionV2Message() {
return (this.match(DCCppConstants.FUNCTION_V2_CMD_REGEX) != null);
}
public boolean isForgetCabMessage() {
return (this.match(DCCppConstants.FORGET_CAB_CMD_REGEX) != null);
}
public boolean isTurnoutMessage() {
return (this.getOpCodeChar() == DCCppConstants.TURNOUT_CMD);
}
public boolean isSensorMessage() {
return (this.getOpCodeChar() == DCCppConstants.SENSOR_CMD);
}
public boolean isEEPROMWriteMessage() {
return (this.getOpCodeChar() == DCCppConstants.WRITE_TO_EEPROM_CMD);
}
public boolean isEEPROMClearMessage() {
return (this.getOpCodeChar() == DCCppConstants.CLEAR_EEPROM_CMD);
}
public boolean isOpsWriteByteMessage() {
return (this.getOpCodeChar() == DCCppConstants.OPS_WRITE_CV_BYTE);
}
public boolean isOpsWriteBitMessage() {
return (this.getOpCodeChar() == DCCppConstants.OPS_WRITE_CV_BIT);
}
public boolean isProgWriteByteMessage() {
return (this.getOpCodeChar() == DCCppConstants.PROG_WRITE_CV_BYTE);
}
public boolean isProgWriteBitMessage() {
return (this.getOpCodeChar() == DCCppConstants.PROG_WRITE_CV_BIT);
}
public boolean isProgReadMessage() {
return (this.getOpCodeChar() == DCCppConstants.PROG_READ_CV);
}
public boolean isProgVerifyMessage() {
return (this.getOpCodeChar() == DCCppConstants.PROG_VERIFY_CV);
}
public boolean isTurnoutCmdMessage() {
return (this.match(DCCppConstants.TURNOUT_CMD_REGEX) != null);
}
public boolean isTurnoutAddMessage() {
return (this.match(DCCppConstants.TURNOUT_ADD_REGEX) != null);
}
public boolean isTurnoutDeleteMessage() {
return (this.match(DCCppConstants.TURNOUT_DELETE_REGEX) != null);
}
public boolean isListTurnoutsMessage() {
return (this.match(DCCppConstants.TURNOUT_LIST_REGEX) != null);
}
public boolean isSensorAddMessage() {
return (this.match(DCCppConstants.SENSOR_ADD_REGEX) != null);
}
public boolean isSensorDeleteMessage() {
return (this.match(DCCppConstants.SENSOR_DELETE_REGEX) != null);
}
public boolean isListSensorsMessage() {
return (this.match(DCCppConstants.SENSOR_LIST_REGEX) != null);
}
//public boolean isOutputCmdMessage() { return(this.getOpCodeChar() == DCCppConstants.OUTPUT_CMD); }
public boolean isOutputCmdMessage() {
return (this.match(DCCppConstants.OUTPUT_CMD_REGEX) != null);
}
public boolean isOutputAddMessage() {
return (this.match(DCCppConstants.OUTPUT_ADD_REGEX) != null);
}
public boolean isOutputDeleteMessage() {
return (this.match(DCCppConstants.OUTPUT_DELETE_REGEX) != null);
}
public boolean isListOutputsMessage() {
return (this.match(DCCppConstants.OUTPUT_LIST_REGEX) != null);
}
public boolean isQuerySensorStatesMessage() {
return (this.match(DCCppConstants.QUERY_SENSOR_STATES_REGEX) != null);
}
public boolean isWriteDccPacketMessage() {
return ((this.getOpCodeChar() == DCCppConstants.WRITE_DCC_PACKET_MAIN) || (this.getOpCodeChar() == DCCppConstants.WRITE_DCC_PACKET_PROG));
}
//------------------------------------------------------
// Helper methods for Sensor Query Commands
public String getOutputIDString() {
if (this.isOutputAddMessage() || this.isOutputDeleteMessage() || this.isOutputCmdMessage()) {
return getValueString(1);
} else {
log.error("Output Parser called on non-Output message type {}", this.getOpCodeChar());
return ("0");
}
}
public int getOutputIDInt() {
if (this.isOutputAddMessage() || this.isOutputDeleteMessage() || this.isOutputCmdMessage()) {
return (getValueInt(1)); // assumes stored as an int!
} else {
log.error("Output Parser called on non-Output message type {}", this.getOpCodeChar());
return (0);
}
}
public String getOutputPinString() {
if (this.isOutputAddMessage()) {
return (getValueString(2));
} else {
log.error("Output Parser called on non-Output message type {}", this.getOpCodeChar());
return ("0");
}
}
public int getOutputPinInt() {
if (this.isOutputAddMessage()) {
return (getValueInt(2));
} else {
log.error("Output Parser called on non-Output message type {}", this.getOpCodeChar());
return (0);
}