-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
m_bus.c
1274 lines (1153 loc) · 49.8 KB
/
m_bus.c
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
/** @file
Wireless M-Bus (EN 13757-4).
Copyright (C) 2018 Tommy Vestermark
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
*/
/**
Wireless M-Bus (EN 13757-4).
Implements the Physical layer (RF receiver) and Data Link layer of the
Wireless M-Bus protocol. Will return a data string (including the CI byte)
for further processing by an Application layer (outside this program).
*/
#include "decoder.h"
#define BLOCK1A_SIZE 12 // Size of Block 1, format A
#define BLOCK1B_SIZE 10 // Size of Block 1, format B
#define BLOCK2B_SIZE 118 // Maximum size of Block 2, format B
#define BLOCK1_2B_SIZE 128
// Convert two BCD encoded nibbles to an integer
static unsigned bcd2int(uint8_t bcd)
{
return 10*(bcd>>4) + (bcd & 0xF);
}
// Mapping from 6 bits to 4 bits. "3of6" coding used for Mode T
static uint8_t m_bus_decode_3of6(uint8_t byte)
{
uint8_t out = 0xFF; // Error
//fprintf(stderr,"Decode %0d\n", byte);
switch(byte) {
case 22: out = 0x0; break; // 0x16
case 13: out = 0x1; break; // 0x0D
case 14: out = 0x2; break; // 0x0E
case 11: out = 0x3; break; // 0x0B
case 28: out = 0x4; break; // 0x17
case 25: out = 0x5; break; // 0x19
case 26: out = 0x6; break; // 0x1A
case 19: out = 0x7; break; // 0x13
case 44: out = 0x8; break; // 0x2C
case 37: out = 0x9; break; // 0x25
case 38: out = 0xA; break; // 0x26
case 35: out = 0xB; break; // 0x23
case 52: out = 0xC; break; // 0x34
case 49: out = 0xD; break; // 0x31
case 50: out = 0xE; break; // 0x32
case 41: out = 0xF; break; // 0x29
default: break; // Error
}
return out;
}
// Decode input 6 bit nibbles to output 4 bit nibbles (packed in bytes). "3of6" coding used for Mode T
// Bad data must be handled with second layer CRC
static int m_bus_decode_3of6_buffer(uint8_t const *bits, unsigned bit_offset, uint8_t* output, unsigned num_bytes)
{
for (unsigned n=0; n<num_bytes; ++n) {
uint8_t nibble_h = m_bus_decode_3of6(bitrow_get_byte(bits, n*12+bit_offset) >> 2);
uint8_t nibble_l = m_bus_decode_3of6(bitrow_get_byte(bits, n*12+bit_offset+6) >> 2);
if (nibble_h > 0xf || nibble_l > 0xf) {
return -1;
}
output[n] = (nibble_h << 4) | nibble_l;
}
return 0;
}
// Validate CRC
static int m_bus_crc_valid(r_device *decoder, const uint8_t *bytes, unsigned crc_offset)
{
static const uint16_t CRC_POLY = 0x3D65;
uint16_t crc_calc = ~crc16(bytes, crc_offset, CRC_POLY, 0);
uint16_t crc_read = (((uint16_t)bytes[crc_offset] << 8) | bytes[crc_offset+1]);
if (crc_calc != crc_read) {
decoder_logf(decoder, 1, __func__, "M-Bus: CRC error: Calculated 0x%X, Read: 0x%X", (unsigned)crc_calc, (unsigned)crc_read);
return 0;
}
return 1;
}
// Decode two bytes into three letters of five bits
static void m_bus_manuf_decode(uint16_t m_field, char *three_letter_code)
{
three_letter_code[0] = (m_field >> 10 & 0x1F) + 0x40;
three_letter_code[1] = (m_field >> 5 & 0x1F) + 0x40;
three_letter_code[2] = (m_field & 0x1F) + 0x40;
three_letter_code[3] = 0;
}
// Decode device type string
static char const *m_bus_device_type_str(uint8_t devType)
{
char const *str = "";
switch(devType) {
case 0x00: str = "Other"; break;
case 0x01: str = "Oil"; break;
case 0x02: str = "Electricity"; break;
case 0x03: str = "Gas"; break;
case 0x04: str = "Heat"; break;
case 0x05: str = "Steam"; break;
case 0x06: str = "Warm Water"; break;
case 0x07: str = "Water"; break;
case 0x08: str = "Heat Cost Allocator"; break;
case 0x09: str = "Compressed Air"; break;
case 0x0A:
case 0x0B: str = "Cooling load meter"; break;
case 0x0C: str = "Heat"; break;
case 0x0D: str = "Heat/Cooling load meter"; break;
case 0x0E: str = "Bus/System component"; break;
case 0x0F: str = "Unknown"; break;
case 0x15: str = "Hot Water"; break;
case 0x16: str = "Cold Water"; break;
case 0x17: str = "Hot/Cold Water meter"; break;
case 0x18: str = "Pressure"; break;
case 0x19: str = "A/D Converter"; break;
case 0x1A: str = "Smoke detector"; break;
case 0x1B: str = "Room sensor"; break;
case 0x1C: str = "Gas detector"; break;
case 0x20: str = "Breaker (electricity)"; break;
case 0x21: str = "Valve (gas or water)"; break;
case 0x28: str = "Waste water meter"; break;
case 0x29: str = "Garbage"; break;
case 0x2A: str = "Carbon dioxide"; break;
case 0x25: str = "Customer unit (display device)";break;
case 0x31: str = "Communication controller";break;
case 0x32: str = "Unidirectional repeater";break;
case 0x33: str = "Bidirectional repeater";break;
case 0x36: str = "Radio converter (system side)";break;
case 0x37: str = "Radio converter (meter side)";break;
default: break; // Unknown
}
return str;
}
// Data structure for application layer
typedef struct {
uint8_t CI; // Control info
uint8_t AC; // Access number
uint8_t ST;
uint16_t CW; // Configuration word
uint8_t pl_offset; // Payload offset
/* KNX */
uint8_t knx_ctrl;
uint16_t src;
uint16_t dst;
uint8_t l_npci;
uint8_t tpci;
uint8_t apci;
} m_bus_block2_t;
// Data structure for block 1
typedef struct {
uint8_t L; // Length
uint8_t C; // Control
char M_str[4]; // Manufacturer (encoded as 2 bytes)
uint32_t A_ID; // Address, ID
uint8_t A_Version; // Address, Version
uint8_t A_DevType; // Address, Device Type
uint16_t CRC; // Optional (Only for Format A)
m_bus_block2_t block2;
int knx_mode;
uint8_t knx_sn[6];
} m_bus_block1_t;
typedef struct {
unsigned length;
uint8_t data[512];
} m_bus_data_t;
static float const humidity_factor[2] = { 0.1f, 1.0f };
static char const *oms_hum[4][4] = {
{"humidity","average_humidity_1h","average_humidity_24h","error_04", },
{"maximum_humidity_1h","maximum_humidity_24h","error_13","error_14",},
{"minimum_humidity_1h","minimum_humidity_24h","error_23","error_24",},
{"error_31","error_32","error_33","error_34",}
};
static char const *oms_hum_el[4][4] = {
{"Humidity","Average Humidity 1h","Average Humidity 24h","Error [0][4]", },
{"Maximum Humidity 1h","Maximum Humidity 24h","Error [1][3]","Error [1][4]",},
{"Minimum Humidity 1h","Minimum Humidity 24h","Error [2][3]","Error [2][4]",},
{"Error 31","Error 32","Error 33","Error 34",}
};
static char const *history_hours[4] = {
"1h", "24h", "err[2]", "err[3]",
};
static char const *history_months[12][2] = {
{"m1", "of month -1"},
{"m2", "of month -2"},
{"m3", "of month -3"},
{"m4", "of month -4"},
{"m5", "of month -5"},
{"m6", "of month -6"},
{"m7", "of month -7"},
{"m8", "of month -8"},
{"m9", "of month -9"},
{"m10", "of month -10"},
{"m11", "of month -11"},
{"m12", "of month -12"},
};
static char const *value_types_tab[4][2] = {
{"inst", ""},
{"max", "Max"},
{"min", "Min"},
{"err", "Err"},
};
enum UnitType {
kEnergy_Wh = 0,
kEnergy_J,
kVolume,
kMass,
kPower_W,
kPower_Jh,
kVolumeFlow_h,
kVolumeFlow_min,
kVolumeFlow_s,
kMassFlow,
kTemperatureFlow,
kTemperatureReturn,
kTemperatureDiff,
kTemperatureExtern,
kPressure,
kTimeDate,
kDate,
kHca,
kOnTimeSec,
kOnTimeMin,
kOnTimeHours,
kOnTimeDays,
kOperTimeSec,
kOperTimeMin,
kOperTimeHours,
kOperTimeDays,
};
static char const *unit_names[][3] = {
/* 0 */ {"energy_wh", "Energy", "Wh"},
/* 1 */ {"energy_j", "Energy", "J"},
/* 2 */ {"volume", "Volume", "m3"},
/* 3 */ {"mass", "Mass", "kg"},
/* 4 */ {"power_w", "Power", "W"},
/* 5 */ {"power_jh", "Power", "J/h"},
/* 6 */ {"volume_flow_h", "Volume flow", "m3/h"},
/* 7 */ {"volume_flow_min", "Volume flow", "m3/min"},
/* 8 */ {"volume_flow_s", "Volume flow", "l/s"},
/* 9 */ {"mass_flow", "Mass flow", "kg/h"},
/*10 */ {"temperature_flow", "Flow temperature", "C"},
/*11 */ {"temperature_return", "Return temperature", "C"},
/*12 */ {"temperature_diff", "Temperature diff", "K"},
/*13 */ {"temperature_ext", "Temperature extern", "C"},
/*14 */ {"pressure", "Pressure", "bar"},
/*15 */ {"timedate", "TimeDate", ""},
/*16 */ {"date", "Date", ""},
/*17 */ {"hca", "HCA", ""},
/*18 */ {"ontime_s", "OnTime", "s"},
/*19 */ {"ontime_m", "OnTime", "min"},
/*20 */ {"ontime_h", "OnTime", "hours"},
/*21 */ {"ontime_d", "OnTime", "days"},
/*22 */ {"opertime_s", "OperTime", "s"},
/*23 */ {"opertime_m", "OperTime", "min"},
/*24 */ {"opertime_h", "OperTime", "hours"},
/*25 */ {"opertime_d", "OperTime", "days"},
};
// exponent -3 -2 -1 0 1 2 3 4
// index 0 1 2 3 4 5 6 7
static double const pow10_table[8] = { 0.001, 0.01, 0.1, 1, 10, 100, 1000, 10000 };
static data_t *append_str(data_t *data, enum UnitType unit_type, uint8_t value_type, uint8_t sn,
char const *key_extra, char const *pretty_extra, char const *value)
{
char key[100] = {0};
char pretty[100] = {0};
value_type &= 0x3;
if (!key_extra || !*key_extra) {
snprintf(key, sizeof(key), "%s_%s_%d", value_types_tab[value_type][0], unit_names[unit_type][0], sn);
} else {
snprintf(key, sizeof(key), "%s_%s_%s_%d", value_types_tab[value_type][0], unit_names[unit_type][0], key_extra, sn);
}
if (!pretty_extra || !*pretty_extra) {
snprintf(pretty, sizeof(pretty), "%s %s[%d]", value_types_tab[value_type][1], unit_names[unit_type][1], sn);
} else {
snprintf(pretty, sizeof(pretty), "%s %s %s", value_types_tab[value_type][1], unit_names[unit_type][1], pretty_extra);
}
return data_append(data,
key, pretty, DATA_STRING, value, NULL);
}
static data_t *append_val(data_t *data, enum UnitType unit_type, uint8_t value_type, uint8_t sn,
char const *key_extra, char const *pretty_extra, int64_t val, int exp)
{
char const *prefix = "";
char buffer_val[256] = {0};
if (exp < -6) {
exp += 6;
prefix = "u";
} else if (exp < -3) {
exp += 3;
prefix = "m";
} else if (exp <= 0) {
prefix = "";
} else if (exp <= 3) {
exp -= 3;
prefix = "k";
} else if (exp <= 6) {
exp -= 6;
prefix = "M";
} else if (exp <= 9) {
exp -= 9;
prefix = "G";
}
// adapt for table index
exp += 3;
if (exp < 0 || exp > 7) {
fprintf(stderr, "M-Bus: Program error, exp (%d) is out of bounds", exp);
return data;
}
double fvalue = val * pow10_table[exp];
snprintf(buffer_val, sizeof(buffer_val), "%.3f %s%s", fvalue, prefix, unit_names[unit_type][2]);
return append_str(data, unit_type, value_type, sn, key_extra, pretty_extra, buffer_val);
}
static size_t m_bus_tm_decode(const uint8_t *data, size_t data_size, char *output, size_t output_size)
{
size_t out_len = 0;
if (output == NULL) {
return 0;
}
switch(data_size) {
case 6: // Type I = Compound CP48: Date and Time
if ((data[1] & 0x80) != 0) { // Time valid ?
out_len = snprintf(output, output_size, "invalid");
break;
}
out_len = snprintf(output, output_size, "%02d-%02d-%02dT%02d:%02d:%02d",
((data[3] & 0xE0) >> 5) | ((data[4] & 0xF0) >> 1),
data[4] & 0x0F,
data[3] & 0x1F,
data[2] & 0x1F,
data[1] & 0x3F,
data[0] & 0x3F
);
// (data[0] & 0x40) ? 1 : 0; // day saving time
break;
case 4: // Type F = Compound CP32: Date and Time
if ((data[0] & 0x80) != 0) { // Time valid ?
out_len = snprintf(output, output_size, "invalid");
break;
}
out_len = snprintf(output, output_size, "%02d-%02d-%02dT%02d:%02d:00",
((data[2] & 0xE0) >> 5) | ((data[3] & 0xF0) >> 1), // year
data[3] & 0x0F, // mon
data[2] & 0x1F, // mday
data[1] & 0x1F, // hour
data[0] & 0x3F // sec
);
// (data[1] & 0x80) ? 1 : 0; // day saving time
break;
case 2: // Type G: Compound CP16: Date
if ((data[1] & 0x0F) > 12) { // Date valid ?
out_len = snprintf(output, output_size, "invalid");
break;
}
out_len = snprintf(output, output_size, "%02d-%02d-%02d",
((data[0] & 0xE0) >> 5) | ((data[1] & 0xF0) >> 1), // year
data[1] & 0x0F, // mon
data[0] & 0x1F // mday
);
break;
default:
out_len = snprintf(output, output_size, "unknown");
break;
}
return out_len;
}
/**
* @brief decode value from the data stream
*
* @param b data stream
* @param dif_coding type/size of value
* @param out_value pointer where value will be stored
* @return size_t number of consumed bytes. -1 if error or unknown coding
*/
static int m_bus_decode_val(const uint8_t *b, uint8_t dif_coding, int64_t *out_value)
{
uint64_t val = 0;
*out_value = 0;
switch (dif_coding) {
case 15: // special function
return -1;
case 14: // 12 digit BCD
for (int i=5; i >= 0;--i) {
*out_value = (*out_value * 10) + (b[i] >> 4);
*out_value = (*out_value * 10) + (b[i] & 0xF);
}
return 6;
case 13: // variable len
return -1;
case 12: // 8 digit BCD
for (int i=3; i >= 0;--i) {
*out_value = (*out_value * 10) + (b[i] >> 4);
*out_value = (*out_value * 10) + (b[i] & 0xF);
}
return 4;
case 11: // 6 digit BCD
for (int i=2; i >= 0;--i) {
*out_value = (*out_value * 10) + (b[i] >> 4);
*out_value = (*out_value * 10) + (b[i] & 0xF);
}
return 3;
case 10: // 4 digit BCD
for (int i=1; i >= 0;--i) {
*out_value = (*out_value * 10) + (b[i] >> 4);
*out_value = (*out_value * 10) + (b[i] & 0xF);
}
return 2;
case 9: // 2 digit BCD
*out_value = (b[0] >> 4) * 10;
*out_value += b[0] & 0xF;
return 1;
case 8: // Selection for Readout
return -1;
case 7: // 64bit
for (int i=7; i >= 0;--i) {
*out_value = (*out_value << 8) | b[i];
}
return 8;
case 6: // 48bit
if (b[5] & 0x80) {
val = 0xFFFFFF;
}
for (int i=5; i >= 0;--i) {
val = (val << 8) | b[i];
}
*out_value = (int64_t)val;
return 6;
case 5: // 32bit float
*out_value = 0; // TODO
return -1;
case 4: // 32bit
*out_value = (int32_t)(b[3] << 24 | b[2] << 16 | b[1] << 8 | b[0]);
return 4;
case 3: // 24bit
if (b[2] & 0x80) {
val = 0xFFFFFFFFFF;
}
val = (val << 8) | b[2];
val = (val << 8) | b[1];
val = (val << 8) | b[0];
*out_value = (int64_t)val;
return 3;
case 2: // 16bit
*out_value = (int16_t)(b[1] << 8 | b[0]);
return 2;
case 1: // 8bit
*out_value = (int8_t)b[0];
return 1;
case 0: // no data
return 0;
default:
break;
}
return -1;
}
/**
* @brief decode wireless mbus records
*
* @param[in,out] inout_data pointer to output data for decoded records
* @param b input buffer with records
* @param dif_coding Data Information - Length and coding of data (2=16bit,4=32bit, etc)
* @param vif_linear Value Information Field
* @param vif_uam Value Information Field - unit type + multiplier
* @param dif_sn Data Information Field - storage number
* @param dif_ff Data Information Field - function field (00b Instantaneous value
* 01b Maximum value
* 10b Minimum value
* 11b Value during error state)
* @param dif_su Data Information Field -
* @return int
*/
static int m_bus_decode_records(data_t **inout_data, const uint8_t *b, uint8_t dif_coding, uint8_t vif_linear, uint8_t vif_uam, uint8_t dif_sn, uint8_t dif_ff, uint8_t dif_su)
{
data_t *data = *inout_data;
int ret = 0;
int state;
int64_t val = 0;
ret = m_bus_decode_val(b, dif_coding, &val);
// for reverse engineering
// fprintf(stderr, "**decoding dif_coding=%d, vif=0x%02x, vif_uam=0x%02x, dif_ff=%d, dif_sn=%d, dif_su=%d, b[3]=0x%02X, b[2]=0x%02X,b[1]=0x%02X, b[0]=0x%02X, val=%ld**\n",
// dif_coding, vif_linear, vif_uam, dif_ff, dif_sn, dif_su, b[3], b[2], b[1], b[0], val);
switch (vif_linear) {
case 0:
if ((vif_uam&0xF8) == 0) {
// E000 0nnn Energy 10nnn-3 Wh 0.001Wh to 10000Wh
data = append_val(data, kEnergy_Wh, dif_ff, dif_sn, "", "", val, -3 + (vif_uam&0x7));
} else if ((vif_uam&0xF8) == 0x08) {
// E000 1nnn Energy 10nnn J 0.001kJ to 10000kJ
data = append_val(data, kEnergy_J, dif_ff, dif_sn, "", "", val, vif_uam&0x7);
} else if ((vif_uam&0xF8) == 0x10) {
// E001 0nnn Volume 10nnn-6 m3 0.001l to 10000l
if (dif_sn == 0) {
data = append_val(data, kVolume, dif_ff, dif_sn, "", "", val, -6 + (vif_uam&0x7));
} else
if (dif_sn >= 8 && dif_sn <= 19) {
dif_sn -= 8;
data = append_val(data, kVolume, dif_ff, dif_sn,
history_months[dif_sn][0], history_months[dif_sn][1], val, -6 + (vif_uam&0x7));
}
} else if ((vif_uam&0xF8) == 0x18) {
// E001 1nnn Mass 10nnn-3 kg 0.001kg to 10000kg
data = append_val(data, kEnergy_J, dif_ff, dif_sn, "", "", val, -3 + (vif_uam&0x7));
} else if ((vif_uam&0xFC) == 0x20) {
/* E010 00nn On Time nn = 00 seconds
nn = 01 minutes
nn = 10 hours
nn = 11 days */
switch (vif_uam&3) {
case 0: data = append_val(data, kOnTimeSec, dif_ff, dif_sn, "", "", val, 0); break;
case 1: data = append_val(data, kOnTimeMin, dif_ff, dif_sn, "", "", val, 0); break;
case 2: data = append_val(data, kOnTimeHours, dif_ff, dif_sn, "", "", val, 0); break;
case 3: data = append_val(data, kOnTimeDays, dif_ff, dif_sn, "", "", val, 0); break;
default: break;
}
} else if ((vif_uam&0xFC) == 0x24) {
// E010 01nn Operating Time coded like OnTime
switch (vif_uam&3) {
case 0: data = append_val(data, kOperTimeSec, dif_ff, dif_sn, "", "", val, 0); break;
case 1: data = append_val(data, kOperTimeMin, dif_ff, dif_sn, "", "", val, 0); break;
case 2: data = append_val(data, kOperTimeHours, dif_ff, dif_sn, "", "", val, 0); break;
case 3: data = append_val(data, kOperTimeDays, dif_ff, dif_sn, "", "", val, 0); break;
default: break;
}
} else if ((vif_uam&0xF8) == 0x28) {
// E010 1nnn Power 10nnn-3 W 0.001W to 10000W
data = append_val(data, kPower_W, dif_ff, dif_sn, "", "", val, -3 + (vif_uam&0x7));
} else if ((vif_uam&0xF8) == 0x30) {
// E011 0nnn Power 10nnn J/h 0.001kJ/h to 10000kJ/h
data = append_val(data, kPower_Jh, dif_ff, dif_sn, "", "", val, vif_uam&0x7);
} else if ((vif_uam&0xF8) == 0x38) {
// E011 1nnn Volume Flow 10nnn-6 m3/h 0.001l/h to 10000l/h
data = append_val(data, kVolumeFlow_h, dif_ff, dif_sn, "", "", val, -6 + (vif_uam&0x7));
} else if ((vif_uam&0xF8) == 0x40) {
// E100 0nnn Volume Flow ext. 10nnn-7 m3/min 0.0001l/min to 1000l/min
data = append_val(data, kVolumeFlow_min, dif_ff, dif_sn, "", "", val, -7 + (vif_uam&0x7));
} else if ((vif_uam&0xF8) == 0x48) {
// E100 1nnn Volume Flow ext. 10nnn-9 m³/s 0.001ml/s to 10000ml/s
// in litres so exp -3
data = append_val(data, kVolumeFlow_s, dif_ff, dif_sn, "", "", val, -3 + (vif_uam&0x7));
} else if ((vif_uam&0xF8) == 0x50) {
// E101 0nnn Mass flow 10nnn-3 kg/h 0.001kg/h to 10000kg/h
data = append_val(data, kMassFlow, dif_ff, dif_sn, "", "", val, -3 + (vif_uam&0x7));
} else if ((vif_uam&0xFC) == 0x58) {
// E101 10nn Flow Temperature 10nn-3 °C 0.001°C to 1°C
data = append_val(data, kTemperatureFlow, dif_ff, dif_sn, "", "", val, -3 + (vif_uam&0x3));
} else if ((vif_uam&0xFC) == 0x5C) {
// E101 11nn Return Temperature 10nn-3 °C 0.001°C to 1°C
data = append_val(data, kTemperatureReturn, dif_ff, dif_sn, "", "", val, -3 + (vif_uam&0x3));
} else if ((vif_uam&0xFC) == 0x60) {
// E110 00nn Temperature Difference 10nn-3 K 1mK to 1000mK
data = append_val(data, kTemperatureDiff, dif_ff, dif_sn, "", "", val, -3 + (vif_uam&0x3));
} else if ((vif_uam&0xFC) == 0x64) {
// E110 01nn External temperature 10 nn-3 ° C 0.001 ° C to 1 ° C
data = append_val(data, kTemperatureExtern, dif_ff, dif_sn, "", history_hours[dif_sn&0x3], val, -3 + (vif_uam&0x3));
} else if ((vif_uam&0xFC) == 0x68) {
// E110 10nn Pressure 10nn-3 bar 1mbar to 1000mbar
data = append_val(data, kPressure, dif_ff, dif_sn, "", "", val, -3 + (vif_uam&0x3));
} else if ((vif_uam&0xFE) == 0x6C) {
// E110 110n Time Point n = 0 date, n = 1 time & date
char buff_time[256] = {0};
if (vif_uam&1) {
if (m_bus_tm_decode(b, dif_coding, buff_time, sizeof(buff_time))) {
data = append_str(data, kTimeDate, dif_ff, dif_sn, "", "", buff_time);
}
} else {
if (m_bus_tm_decode(b, dif_coding, buff_time, sizeof(buff_time))) {
data = append_str(data, kDate, dif_ff, dif_sn, "", "", buff_time);
}
}
} else if (vif_uam == 0x6E) {
// E110 1110 Units for H.C.A. dimensionless
data = append_val(data, kHca, dif_ff, dif_sn, "", "", val, 0);
} else if ((vif_uam&0xFC) == 0x70) {
// E111 00nn Averaging Duration coded like OnTime
} else if ((vif_uam&0xFC) == 0x74) {
// E111 01nn Actuality Duration coded like OnTime
} else if (vif_uam == 0x78) {
// E111 1000 Fabrication No
} else if (vif_uam == 0x79) {
// E111 1001 Enhanced Identification
} else if (vif_uam == 0x7A) {
// E111 1010 Bus Address data type C (x=8)
} else {
// reserved
data = data_append(data,
"unknown", "Unknown", DATA_STRING, "none",
NULL);
}
break;
case 0x7B:
switch(vif_uam>>1) {
case 0xD:
data = data_append(data,
oms_hum[dif_ff&0x3][dif_sn&0x3], oms_hum_el[dif_ff&0x3][dif_sn&0x3], DATA_FORMAT, "%.1f %%", DATA_DOUBLE, val*humidity_factor[vif_uam&0x1],
NULL);
break;
default:
break;
}
break;
case 0x7D:
switch(vif_uam) {
case 0x1b:
// If tamper is triggered the bit 0 and 4 is set
// Open sets bits 2 and 6 to 1
// Close sets bits 2 and 6 to 0
state = b[0]&0x44;
data = data_append(data,
"switch", "Switch", DATA_STRING, (state==0x44) ? "open":"closed",
NULL);
break;
case 0x3a:
/* Only use 32 bits of 48 available */
data = data_append(data,
((dif_su==0)?"counter_0":"counter_1"), ((dif_su==0)?"Counter 0":"Counter 1"), DATA_FORMAT, "%d", DATA_INT, (b[3]<<24|b[2]<<16|b[1]<<8|b[0]),
NULL);
break;
default:
break;
}
break;
default:
break;
}
*inout_data = data;
return ret;
}
static void parse_payload(data_t *data, const m_bus_block1_t *block1, const m_bus_data_t *out)
{
uint8_t off = block1->block2.pl_offset;
const uint8_t *b = out->data;
/* Align offset pointer, there might be 2 0x2F bytes */
if (b[off] == 0x2F) off++;
if (b[off] == 0x2F) off++;
// [02 65] 9f08 [42 65] 9e08 [8201 65] 8f08 [02 fb1a] 3601 [42 fb1a] 3701 [8201 fb1a] 3001
//[02 65] b408 [42 65] a008 [8201 65] 6408 [22 65] 9608 [12 65] ac08 [62 65] 2808 [52 65] 920802fb1a470142fb1a4a018201fb1a550122fb1a4a0112fb1a4a0162fb1a3c0152fb1a6c01066dbb3197902100
/* Payload must start with a DIF */
while (off < block1->L) {
uint8_t dif;
uint8_t dife_array[10] = {0};
uint8_t dife_cnt;
uint8_t dif_coding;
uint8_t dif_sn;
uint8_t dif_ff;
uint8_t dif_su;
uint8_t vif;
uint8_t vife_array[10] = {0};
uint8_t vife_cnt;
uint8_t vif_uam;
uint8_t vif_linear;
dife_cnt = 0;
vife_cnt = 0;
/* Parse DIF */
dif = b[off];
dif_sn = (dif&0x40) >> 6;
while (b[off]&0x80) {
off++;
dife_array[dife_cnt++] = b[off];
if (dife_cnt >= 10) return;
}
// Only use first dife in dife_array
dif_sn = ((dife_array[0]&0x0F) << 1) | dif_sn;
dif_su = ((dife_array[0]&0x40) >> 6);
off++;
dif_coding = dif&0x0F;
dif_ff = (dif&0x30) >> 4;
/* Parse VIF */
vif = b[off];
while (b[off]&0x80) {
off++;
vife_array[vife_cnt++] = b[off]&0x7F;
if (vife_cnt >= 10) return;
}
off++;
/* Linear VIF-extension */
if (vif == 0xFB) {
vif_linear = 0x7B;
vif_uam = vife_array[0];
} else if (vif == 0xFD) {
vif_linear = 0x7D;
vif_uam = vife_array[0];
} else {
vif_linear = 0;
vif_uam = vif&0x7F;
}
int consumed = m_bus_decode_records(&data, &b[off], dif_coding, vif_linear, vif_uam, dif_sn, dif_ff, dif_su);
if (consumed == -1) return;
off +=consumed;
}
}
static int parse_block2(const m_bus_data_t *in, m_bus_block1_t *block1)
{
m_bus_block2_t *b2 = &block1->block2;
const uint8_t *b = in->data+BLOCK1A_SIZE;
if (block1->knx_mode) {
b2->knx_ctrl = b[0];
b2->src = b[1]<< 8 | b[2];
b2->dst = b[3]<< 8 | b[4];
b2->l_npci = b[5];
b2->tpci = b[6];
b2->apci = b[7];
/* data */
} else {
b2->CI = b[0];
/* Short transport layer */
if (b2->CI == 0x7A) {
b2->AC = b[1];
b2->ST = b[2];
b2->CW = b[4]<<8 | b[3];
b2->pl_offset = BLOCK1A_SIZE-2 + 5;
}
// fprintf(stderr, "Instantaneous Value: %02x%02x : %f\n",b[9],b[10],((b[10]<<8)|b[9])*0.01);
}
return 0;
}
static int m_bus_decode_format_a(r_device *decoder, const m_bus_data_t *in, m_bus_data_t *out, m_bus_block1_t *block1)
{
// Get Block 1
block1->L = in->data[0];
block1->C = in->data[1];
/* Check for KNX RF default values */
if ((in->data[2]==0xFF) && (in->data[3]==0x03)) {
block1->knx_mode = 1;
memcpy(block1->knx_sn, &in->data[4], 6);
} else {
m_bus_manuf_decode((uint32_t)(in->data[3] << 8 | in->data[2]), block1->M_str); // Decode Manufacturer
block1->A_ID = bcd2int(in->data[7])*1000000 + bcd2int(in->data[6])*10000 + bcd2int(in->data[5])*100 + bcd2int(in->data[4]);
block1->A_Version = in->data[8];
block1->A_DevType = in->data[9];
}
// Store length of data
out->length = block1->L-9 + BLOCK1A_SIZE-2;
// Validate CRC
if (!m_bus_crc_valid(decoder, in->data, 10)) return 0;
// Check length of package is sufficient
unsigned num_data_blocks = (block1->L-9+15)/16; // Data blocks are 16 bytes long + 2 CRC bytes (not counted in L)
if ((block1->L < 9) || ((block1->L-9)+num_data_blocks*2 > in->length-BLOCK1A_SIZE)) { // add CRC bytes for each data block
decoder_logf(decoder, 1, __func__, "M-Bus: Package (%u) too short for packet Length: %u", in->length, block1->L);
decoder_logf(decoder, 1, __func__, "M-Bus: %u > %u", (block1->L-9)+num_data_blocks*2, in->length-BLOCK1A_SIZE);
return 0;
}
memcpy(out->data, in->data, BLOCK1A_SIZE-2);
// Get all remaining data blocks and concatenate into data array (removing CRC bytes)
for (unsigned n=0; n < num_data_blocks; ++n) {
const uint8_t *in_ptr = in->data+BLOCK1A_SIZE+n*18; // Pointer to where data starts. Each block is 18 bytes
uint8_t *out_ptr = out->data+n*16 + BLOCK1A_SIZE-2; // Pointer into block where data starts.
uint8_t block_size = MIN(block1->L-9-n*16, 16)+2; // Maximum block size is 16 Data + 2 CRC
// Validate CRC
if (!m_bus_crc_valid(decoder, in_ptr, block_size-2)) return 0;
// Get block data
memcpy(out_ptr, in_ptr, block_size);
}
parse_block2(in, block1);
return 1;
}
static int m_bus_decode_format_b(r_device *decoder, const m_bus_data_t *in, m_bus_data_t *out, m_bus_block1_t *block1)
{
// Get Block 1
block1->L = in->data[0];
block1->C = in->data[1];
m_bus_manuf_decode((uint32_t)(in->data[3] << 8 | in->data[2]), block1->M_str); // Decode Manufacturer
block1->A_ID = bcd2int(in->data[7])*1000000 + bcd2int(in->data[6])*10000 + bcd2int(in->data[5])*100 + bcd2int(in->data[4]);
block1->A_Version = in->data[8];
block1->A_DevType = in->data[9];
// Store length of data
out->length = block1->L-(9+2) + BLOCK1B_SIZE-2;
// Check length of package is sufficient
if ((block1->L < 12) || (block1->L+1 > (int)in->length)) { // L includes all bytes except itself
decoder_logf(decoder, 1, __func__, "M-Bus: Package too short for Length: %u", block1->L);
return 0;
}
// Validate CRC
if (!m_bus_crc_valid(decoder, in->data, MIN(block1->L-1, (BLOCK1B_SIZE+BLOCK2B_SIZE)-2))) return 0;
// Get data from Block 2
memcpy(out->data, in->data, (MIN(block1->L-11, BLOCK2B_SIZE-2))+BLOCK1B_SIZE);
// Extract extra block for long telegrams (not tested!)
uint8_t L_OFFSET = BLOCK1B_SIZE+BLOCK2B_SIZE-1; // How much to subtract from L (127)
if (block1->L > (L_OFFSET+2)) { // Any more data? (besided 2 extra CRC)
// Validate CRC
if (!m_bus_crc_valid(decoder, in->data+BLOCK1B_SIZE+BLOCK2B_SIZE, block1->L-L_OFFSET-2)) return 0;
// Get Block 3
memcpy(out->data+(BLOCK2B_SIZE-2), in->data+BLOCK2B_SIZE, block1->L-L_OFFSET-2);
out->length -= 2; // Subtract the two extra CRC bytes
}
return 1;
}
static int m_bus_output_data(r_device *decoder, bitbuffer_t *bitbuffer, const m_bus_data_t *out, const m_bus_block1_t *block1, char const *mode)
{
(void)bitbuffer; // note: to match the common decoder function signature
data_t *data;
// Make data string
char str_buf[1024];
sprintf(str_buf, "%02x", out->data[0]-2); // Adjust telegram length
for (unsigned n=1; n<out->length+2; n++) { sprintf(str_buf+n*2, "%02x", out->data[n]); }
// Output data
if (block1->knx_mode) {
char sn_str[7*2] = {0};
for (unsigned n=0; n<6; n++) { sprintf(sn_str+n*2, "%02x", block1->knx_sn[n]); }
/* clang-format off */
data = data_make(
"model", "", DATA_STRING, "KNX-RF",
"sn", "SN", DATA_STRING, sn_str,
"knx_ctrl", "KNX-Ctrl", DATA_FORMAT, "0x%02X", DATA_INT, block1->block2.knx_ctrl,
"src", "Src", DATA_FORMAT, "0x%04X", DATA_INT, block1->block2.src,
"dst", "Dst", DATA_FORMAT, "0x%04X", DATA_INT, block1->block2.dst,
"l_npci", "L/NPCI", DATA_FORMAT, "0x%02X", DATA_INT, block1->block2.l_npci,
"tpci", "TPCI", DATA_FORMAT, "0x%02X", DATA_INT, block1->block2.tpci,
"apci", "APCI", DATA_FORMAT, "0x%02X", DATA_INT, block1->block2.apci,
"data_length","Data Length",DATA_INT, out->length,
"data", "Data", DATA_STRING, str_buf,
"mic", "Integrity", DATA_STRING, "CRC",
NULL);
/* clang-format on */
} else {
/* clang-format off */
data = data_make(
"model", "", DATA_STRING, "Wireless-MBus",
"mode", "Mode", DATA_STRING, mode,
"M", "Manufacturer", DATA_STRING, block1->M_str,
"id", "ID", DATA_INT, block1->A_ID,
"version", "Version", DATA_INT, block1->A_Version,
"type", "Device Type", DATA_FORMAT, "0x%02X", DATA_INT, block1->A_DevType,
"type_string", "Device Type String", DATA_STRING, m_bus_device_type_str(block1->A_DevType),
"C", "Control", DATA_FORMAT, "0x%02X", DATA_INT, block1->C,
// "L", "Length", DATA_INT, block1->L,
"data_length", "Data Length", DATA_INT, out->length,
"data", "Data", DATA_STRING, str_buf,
"mic", "Integrity", DATA_STRING, "CRC",
NULL);
/* clang-format on */
}
if (block1->block2.CI) {
/* clang-format off */
data = data_append(data,
"CI", "Control Info", DATA_FORMAT, "0x%02X", DATA_INT, block1->block2.CI,
"AC", "Access number", DATA_FORMAT, "0x%02X", DATA_INT, block1->block2.AC,
"ST", "Device Type", DATA_FORMAT, "0x%02X", DATA_INT, block1->block2.ST,
"CW", "Configuration Word",DATA_FORMAT, "0x%04X", DATA_INT, block1->block2.CW,
NULL);
/* clang-format on */
}
/* Encryption not supported */
if (!(block1->block2.CW&0x0500)) {
parse_payload(data, block1, out);
} else {
/* clang-format off */
data = data_append(data,
"payload_encrypted", "Payload Encrypted", DATA_FORMAT, "1", DATA_INT, NULL,
NULL);
/* clang-format on */
}
decoder_output_data(decoder, data);
return 1;
}
/**
Wireless M-Bus, Mode C&T.
@sa m_bus_output_data()
*/
static int m_bus_mode_c_t_callback(r_device *decoder, bitbuffer_t *bitbuffer)
{
static const uint8_t PREAMBLE_T[] = {0x54, 0x3D}; // Mode T Preamble (always format A - 3of6 encoded)
// static const uint8_t PREAMBLE_CA[] = {0x55, 0x54, 0x3D, 0x54, 0xCD}; // Mode C, format A Preamble
// static const uint8_t PREAMBLE_CB[] = {0x55, 0x54, 0x3D, 0x54, 0x3D}; // Mode C, format B Preamble
m_bus_data_t data_in = {0}; // Data from Physical layer decoded to bytes
m_bus_data_t data_out = {0}; // Data from Data Link layer
m_bus_block1_t block1 = {0}; // Block1 fields from Data Link layer
char const *mode;
// Validate package length
if (bitbuffer->bits_per_row[0] < (32+13*8) || bitbuffer->bits_per_row[0] > (64+256*12)) { // Min/Max (Preamble + payload)
return DECODE_ABORT_LENGTH;
}
// Find a Mode T or C data package
unsigned bit_offset = bitbuffer_search(bitbuffer, 0, 0, PREAMBLE_T, sizeof(PREAMBLE_T)*8);
if (bit_offset + 13*8 >= bitbuffer->bits_per_row[0]) { // Did not find a big enough package
return DECODE_ABORT_EARLY;
}
decoder_logf_bitbuffer(decoder, 1, __func__, bitbuffer, "PREAMBLE_T: found at: %u", bit_offset);
bit_offset += sizeof(PREAMBLE_T)*8; // skip preamble
uint8_t next_byte = bitrow_get_byte(bitbuffer->bb[0], bit_offset);
bit_offset += 8;
// Mode C
if (next_byte == 0x54) {
mode = "C";
next_byte = bitrow_get_byte(bitbuffer->bb[0], bit_offset);
bit_offset += 8;
// Format A
if (next_byte == 0xCD) {
decoder_log(decoder, 1, __func__, "M-Bus: Mode C, Format A");
// Extract data
data_in.length = (bitbuffer->bits_per_row[0]-bit_offset)/8;
bitbuffer_extract_bytes(bitbuffer, 0, bit_offset, data_in.data, data_in.length*8);
// Decode
if (!m_bus_decode_format_a(decoder, &data_in, &data_out, &block1))
return DECODE_FAIL_SANITY;
} // Format A
// Format B
else if (next_byte == 0x3D) {
decoder_log(decoder, 1, __func__, "M-Bus: Mode C, Format B");
// Extract data
data_in.length = (bitbuffer->bits_per_row[0]-bit_offset)/8;
bitbuffer_extract_bytes(bitbuffer, 0, bit_offset, data_in.data, data_in.length*8);
// Decode
if (!m_bus_decode_format_b(decoder, &data_in, &data_out, &block1))
return DECODE_FAIL_SANITY;
} // Format B
// Unknown Format
else {
decoder_logf_bitbuffer(decoder, 1, __func__, bitbuffer, "M-Bus: Mode C, Unknown format: 0x%X", next_byte);
return 0;
}
} // Mode C
// Mode T
else {
mode = "T";
bit_offset -= 8; // Rewind offset to start of telegram
decoder_log(decoder, 1, __func__, "M-Bus: Mode T");