forked from wmbusmeters/wmbusmeters
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCHANGES
1169 lines (782 loc) · 44.4 KB
/
CHANGES
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
New improved address specification. E.g. use 12345678.M=KAM.V=1b.T=16
to listen to exactly the telegrams with id 12345678 manufacturer KAM,
version 0x1b and type 0x16. You if you do not specify any M,V or T, they
become wildcards which will be the old default behaviour.
If you receive multiple telegram versions from the same id, and you want to
filter out some versions, do: 12345678,!12345678.V=77
You can now specify p0 to p250, to read from an mbus using the primary address.
E.g. wmbusmeters --pollinterval=5s /dev/ttyUSB1:mbus:2400 TEMP piigth:mbus p0 NOKEY
Added option --identitymode=(id|id-mfct|full|none) to specify how
wmbusmeters groups meter state when receiving telegrams.
The default (which is the same as before) is to map state based only on id.
This usually works ok, however if you have two meters with the same id, but
from different manufacturers, you must separate their state with --identitymode=id-mfct
Full takes into account version and type as well. None means do not separate state
at all, used with wildcards and meters that do not need to keep state, ie all info
is in every telegram.
Version 1.16.1 2024-02-22
Fix docker file generation.
Version 1.16.0 2024-02-22
New build to trigger proper docker versioning.
Version 1.15.0 2024-02-14
Version 1.15.0-RC2 2024-02-14
Update wmbusmeters-ha-addon with new dockerfile.
Version 1.15.0-RC1 2024-02-13
For the daemon you can now drop a driver file (such as iperl.xmq) in /etc/wmbusmeters.driver.d
and it will automatically be used (overriding any builtin iperl driver).
From the command line you can also load a driver file with --driver=file.xmq
or load a whole directory with --driverdir=/drivers or in a tuple just use
a file name ending with xmq. E.g. "Water driver.xmq 12345678 NOKEY"
The two first builtin text drivers are elster and iperl.
ATTENTION! Wmbusmeters now use new -f option when starting rtl_wmbus. There is a
warning if rtl_wmbus does not support the -f option and an upgrade is recommended.
This option will cause rtl_wmbus to exit with an error if the rtl_sdr dongle stops sending data.
This in turn will cause wmbusmeters to restart the pipeline.
Up till now, the stderr from rtl_sdr has been sent to /dev/null. This is a problem
since we cannot see any errors from rtl_sdr that could have caused it to stall.
However the reason for /dev/null was this bug in rtl_sdr.
https://github.com/osmocom/rtl-sdr/commit/142325a93c6ad70f851f43434acfdf75e12dfe03
which prevented us from sending the rtl_sdr stderr to wmbusmeters.
If we did, rtl_sdr went into a 100% cpu hang when we restarted a wmbusmeters daemon.
A temporary workaround has been found that both sends the stderr output to wmbusmeters
and permits the restart of the daemon. Stderr from rtl_sdr is now sent to
/tmp/tmp.XXXXXXX_wmbusmeters_rtlsdr and then tailed into wmbusmeters.
This is a temporary solution until the real rtl_sdr bugfix has propagated into enough distributions.
Add second extension energy MWh VIF 7b00-7b01.
Sunflowerenergias improved the iwmtx5 driver! Thanks Sunflowerenergias!
Jacman777 improved the kamheat driver! Thanks Jacman777!
Pim added a --metershell setting which will invoke a shell command line
when a meter is seen for the first time. This can be used to trigger extra
commands in HA and other systems, to add the new meter. Thanks Pim!
Pim added support for the Lansen repeater which sends its own status messages!
Pim also fixed a small typo in the human readable date timestamp format!
Thanks Pim!
ATTENTION! The hydrus driver could report the wrong value for total_at_date_m3
if an at_date had not been reached yet. This is fixed.
Added initial support for drivers that can be loaded from config files.
Properly receive telegrams from amb8465 which is in command mode.
Chris Bednarczyk improved the build process for Darwin/MacOS platform. Thanks Chris!
PovilasID added another Hydrodigit version. Thanks PovilasID!
Added new units for phase angle: deg rad.
Added more fields to the abbb23.
Version 1.14.0 2023-07-02
Version 1.14.0-RC1 2023-07-02
Added more fields to em24 driver.
Added another mfct/type/version combo to em42 driver and the power_kw field.
Mikołaj Milej imporved the installation script! Thanks Mikołaj!
Christian Güdel improved the topaseskr driver to consider negative flows. Thanks Christian!
Peter Vágner improved the lansenth driver to consider negative temperatures. Thanks Peter!
Dennis Metz improved the ultraheat driver to consider negative flow and temperatures. Thanks Dennis!
Bibo added support for the hcae2 driver. Thanks Bibo!
Improve error messages when telegrams with bad length byte are read.
Improve the apator162 driver.
Added the iwmtx5 driver.
Vyacheslav Karpukhin improved the qheat driver to decode proprietary format telegrams. Thanks Vyacheslav!
pvagner improved the lansenth driver to handle negative values. Thanks pvagner!
demetz imporproved ultraheat driver to handle negative values. Thanks demetz!
Version 1.13.1 2023-05-07
Version 1.13.1-RC1 2023-05-07
Fix make install to not trigger a new build.
Version 1.13.0 2023-05-07
Version 1.13.0-RC1 2023-05-07
The ha-addon has been moved to https://github.com/wmbusmeters/wmbusmeters-ha-addon
Bug fixed where an mbus telegram was mistakenly detected as wmbus.
The snap package can now use the serial port so that it works with mbus.
DeDragonSlayer improved the amiplus with the maximum power consumption field. Thanks DeDragonSlayer!
The calculator was improved to properly handle the m3 unit and give a better
error message when a constant number lacks unit.
The sharky driver was improved.
The kamheat driver was updated with operating_time_h and a new auto-detect combo.
Bibo added support for the hydrocal m4 meter,
improved the kem-import and kem-extract scripts and
added support for the Aerius gas meter. Thanks Bibo!
The wmbusmeters-admin tool has been removed since it was never really useful.
It will probably be replaced with something better and http based.
This drops the need for the ncurses dependency.
Version 1.12.0 2023-03-12
Version 1.12.0-RC1 2023-03-12
WMbusmeters has moved to its new github organization: github.com/wmbusmeters
Bibo significantly improved the experience for installing the ha-addon
by downloading a prepared docker image instead of building from scratch!
Use the new ha-addon location: github.com/wmbusmeters/wmbusmeters-ha-addon
Thanks Bibo!
Bibo contributed many github workflow improvements! Thanks Bibo!
Thecem,Krzysztof Hajdamowicz, chpego and convicte contributed several improvements to the ha-addon. Thanks!
idl0r updated the eurosii driver with more telegrams. Thank you idl0r!
Roland Huß contributed compressed telegram format for the multical21. Thanks Roland!
Petter Reinholdtsen contributed several fixes to the deb building process and a speedup
of the build workflow. Thanks Petter!
Added the watertech meter.
Christoph Hannebauer contributed another auto-detect combo for the qheat driver. Thanks Christoph!
Gizmocuz added missing logging for the ell_type. Thanks Gizmocuz!
George Hopkins improved the fhkvdataiii driver to infer the current year and
the rtlwmbus driver to propagate the timestamp from rtlwmbus input into the final
json timestamp. Thanks George!
Rob Peters fixed a missing log output for ell_type. Thanks Rob!
Added the GWF water meter.
Zleba improved the qwater driver! Thanks Zleba!
The option --logfile=syslog now works.
ATTENTION! The hydrus driver has been rewritten from scratch! current_date is now meter_datetime
Several fields were printed with value 0 even if the telegram did not contain the actual zero,
such fields are no longer printed. Also the third text field has changed from max_flow_m3h
to total_at_date_m3. Use --selectfields=... if you are affected.
ATTENTION! The microclima driver has been refactored. The field device_date_time has been renamed
to meter_datetime. Also two fields related to tariffs do not occur in the actual telegrams so these
fields have been removed. The fields output has therefore been drastically changed. Use --selectfields=
to reset your setup. Historical data is now decoded and added to the json.
ATTENTION! The qwater driver has been refactored. The field device_date_time has been renamed
to meter_datetime also the due 17 date fields have been renamed. The error_code field has
disappeared since it was broken anyway and replaced with status.
ATTENTION! The sharky774 driver had a bug that triggered when the meter used Joules instead of kWh.
Also the calculated temperature difference had to be removed. You can re-add the temperature difference
by using --calculate_temperature_difference_c=flow_temperature_c-return_temperature_c
Since a field disappeared the default fields were disrupted and a shorter list of fields
have now been picked for the default fields. Please use --selectedfields=... to recreate
your previous fields.
Also the field operating_time_h now prints the proper operating time and
the new field operating_time_in_error_h prints the time when in error.
ATTENTION! A bug in the hydrocalm3 driver was found. When total_cooling_kwh
and other similar values were used as text fields (not a json fields)
they were replaced with dates instead. This was due to a bug in the new
code handling Quantity::PointInTime.
Version 1.11.0 2022-12-29
Version 1.11.0-RC2 2022-12-29
Improve release process.
Version 1.11.0-RC1 2022-12-29
Chpego and SzczepanLeon improved the HA-addon. Thanks!
Ranma added support for the pollucomf 55 driver. Thanks Ranma!
Jacek27 added another Munia temp/hygrometer version. Thanks Jacek27!
Version 1.10.2 2022-12-05
Stefan Rado improved the mqtt discovery for HA. Thanks Stefan!
Bibo improved the snap build process. Thanks Bibo!
Version 1.10.1 2022-12-05
Fix bug that prevented a direct tty link: /dev/ttyUSB0:device:t1 to work.
Version 1.10.0 2022-12-05
╭─────────────────────────────────────────────────────────────────╮
│ │
│ Important change! The old style │
│ of writing drivers is now gone! BUT BUT BUT │
│ the final set of drivers to be converted were │
│ the multical 302/303/403/602/603/803 meters that │
│ were merged into a single kamheat driver. It was not │
│ possible to keep all of them backwards compatible! │
│ │
│ Note that the default fields for these meters are changed! │
│ Please use --selectfields to resolve this. │
│ │
│ I.e. It is a very good idea to check your multical heat │
│ meter values when you upgrade to wmbusmeters 1.10 ! │
│ │
╰─────────────────────────────────────────────────────────────────╯
Important change! The feature --addconversions=GJ has been removed!!! But there is a replacement!
It was used to add conversions to all energy values into gj, eg you have
total_kwh and add total_gj.
The addconversion feature was too broad and the conversion happened too late in the processing code.
You can now achieve the same thing but you have to specify each field you want to convert
using the calculation feature.
E.g. --calculate_total_gj=total_kwh
ATTENTION! The multical 302/303/403/602/603/803 heat meter drivers have been merged into a single kamheat
driver. Not all values are backwards compatible! I.e. 302 is very changed, less so for the others.
The default fields have changed!
ATTENTION! The gransystems driver has been refactored to the new driver format.
The field currrent_at_phase_1_a has been renamed to current_at_phase_1_a.
The info strings in the "status" field now have underscores instead of spaces within a single string.
ATTENTION! The rfmamb driver has been refactored to the new driver format.
A bug was found and fixed where min and max relative humidity over 1h and 24h were wrong.
The field device_date_time has been renamed to device_datetime.
ATTENTION! The hydrocalm3 driver has been refactored to the new driver format.
The field device_date_time has been renamed to device_datetime.
ATTENTION! The fhkvdataiv driver has been refactored to the new driver format.
The field consumption_at_set_date_17 was wrong and has been renamed to field consumption_at_set_date_8.
ATTENTION! Bug in historical data for sensostar driver. Only the most recent month was correct.
ATTENTION! The topaseskr driver has been refactored to the new driver format.
The field "battery_life_days_remaining_remaining" has been changed to "battery_life_y".
ATTENTION! When values are missing in the fields output, they were previously
reported as "nan" but they are now reported as "null".
ATTENTION! The unismart driver has been refactored to the new driver format.
Several fields were unknown before and are still unknown and their content
have slightly changed: status and version.
The field "other_counter" is replaced with just "other" and its content changed.
The field "suppler_info" is replaced with "supplier_info".
The field "device_date_time" is replaced with "device_timestamp" and now contains seconds
and a timezone.
ATTENTION! A bug was fixed where the on_time_h and operating_time_h
(and related error times) were wrong.
ATTENTION! The lansensm driver now prints an extra field with the minutes since
the last test was made. The json is improved.
ATTENTION! The em24 driver has been refactored to the new driver
format and some errors in the fields were discovered! The reactive
consumption and production values were negative. This was in error,
and due to a missing scale factor for the kvarh unit, they will now be positive.
ATTENTION! The q400 driver has been refactored to the new driver
format and some errors in the fields were discovered! Since the new driver
format cannot generate these wrong json fields, the new q400 driver
is not backwards compatible, except for the total_m3 field which is the same.
Same fields and same content: total_m3, consumption_at_set_date_m3"
Same field different content: meter_datetime now reports a full date time "2019-12-20 13:04"
before it reported only the date "2019-12-20".
New field new content: set_date is now set_datetime and reports "2019-12-01 00:00" instead of "2019-12-00"
For the Axioma version of the q400:
Broken fields: forward_flow_m3h, backward_flow_m3h, set_forward_flow_m3h, set_backward_flow_m3h
replaced with: total_forward_m3, total_backward_m3, forward_at_set_date_m3, backward_at_set_date_m3
Same fields and same content: flow_temperature_c, flow_m3h
---------------------------------------------------------------------------------------------
Karsten Festag added Engelmann FAW Radio transmitter and Engelmann Sensostar U
extended with tests for wmbus and mbus. Thanks Karsten!
Jannick Fahlbusch, Stefan Rado, Jan jnxxx, Ovettel, Artur Ptaszek, Sergey Melnik,
Jan Suchal, Patrick Huesmann improved the HA-addon! Thanks!
Steven Cooreman improved the Itron driver. Thanks Steven!
Patrick Huesmann improved the qwater driver. Thanks Patrick!
Florian Zschetzsche added support for the qheat 55 driver. Thanks Florian!
Lasse Bang Mikkelsen added support for flowiq2200 and HA-addon fixes and kem-import fixes. Thanks Lasse!
Bibo added support for the abbb23 driver and improved the docker builds and the lansensm driver! Thanks Bibo!
Thisandre added support for the mkradio4a and vario511 meters. Thanks Andre!
Added the bfw 240 radio heat cost allocator.
Kajetan Krykwiński added support for the Apator E-ITN heat cost allocator. Thanks Kajetan!
Improved wmbusmeters to gracefully handle bad telegrams with multiple difvif entries
matching the same field. This used to trigger an assert, now the first matching field is used.
Rename option --device=xyz to --overridedevice=xyz and add better error message
if it is used without --useconfig=xyz. --device still works but will eventually be removed.
OPTIONAL fields were only printed in the json, if they appeared in the telegram,
even if the field had received a value before. Now a field will be printed
in the json whenever there is a value stored in the meter object.
I.e. an OPTIONAL field that has never received a value will not be printed.
A NON-OPTIONAL field that has never received a value will be printed with the value null.
Version 1.9.0 2022-09-04
ATTENTION! The multical21 and flowiq drivers have been refactored to the new driver style.
Since the multical21 driver was the first driver ever written, it had some idiosynchrasies.
The json should be entirely backwards compatible but when format=fields is used, the
status field no longer has the days, eg "DRY(22-31 days)" is now just "DRY"
use the json or selectfields=time_dry to get how long it has been dry.
Added check for existance of difvif varlen length byte before reading it. Found by fuzzing.
Thecem added support for the Multical 303 heat meter. Thanks thescem!
Improve minomess driver to handle telegrams from wired m-bus module.
Added Enercal F2 heat meter.
Paulo Rossi added support for the AMB3665-M wmbus dongle for N-mode 169 MHz telegrams. Thanks Paulo!
Version 1.8.0 2022-06-25
ATTENTION! Counter suffix _int is changed to _counter.
New fields are added to lansendw, lansenpu, qsmoke drivers.
Eventually the old fields will go away in drivers.
ATTENTION! When a field is not optional in the driver description,
but alas, no data has arrived in the telegram, then the json now
contains a null for the value! Previousy 0 was used, which was misleading.
ATTENTION! The default location of the meter_readings directory has changed
from /var/log/wmbusmeters/meter_readings to /var/lib/wmbusmeters/meter_readings
This only affects new installations. Existing conf files will use the old location
as specified int the conf file.
Added apator172 water meter.
Added qualcosonic heating/cooling meter.
Added ei6500 smoke detector.
Added kampress pressure sensor.
Added hydroclima HCA.
Add detection of bad CUL firmware.
Using :mbus as suffix to the meter driver now works to poll a meter of mbus instead of
listening to wmbus telegrams.
wmbusmeters --pollinterval=1h --format=json MAIN=/dev/ttyUSB0:mbus:2400 MyTemp piigth:MAIN:mbus 12301234 NOKEY
Added --pollinterval=<time> to set the poll interval for all meters to 10 minutes.
As <time> you can say 5s 10m 11h etc.
Added --ppjson to pretty print json, ie add newlines and indentation.
Alexander Streit added support for the Zenner Zelsius C5 ISF heat meter. Thanks Alexander!
Version 1.7.0 2022-03-28
Added verio451mid heat meter.
Improved --analyze command significantly.
ldebomy fixed a bug in the izar decoding that for some meters dropped the most significant digit
in the serial number. Thanks ldebomy!
Germar Reitze fixed a bug where negative BCD values were not properly converted. Thanks Germar!
Fix unnecessary probing bug where a specified device like: /dev/ttyUSB0:im871a:c1
and im871a:c1 would still cause wmbusmeters to probe for all types of devices on the serial port(s).
Now it only probes for im871a which speeds up the startup time significantly.
The sharky774 was improved to handle more different meter configurations.
Michael Ott fixed a bug in oneshot. Thanks Michael!
Fix bug in mode 7 decryption when the encrypted data was followed by non-encrypted data.
NOTE! Json slight json output change drivers esyswm and evo868 where fabrication now is now properly reversed.
You can now combine --useconfig=<dir> with --oneshot --exitafter=<time>
--silent --verbose --debug --normal --trace to override the config file settings.
(Already existing possible overrides was --device=<device> and --listento<mode>.)
This can be useful if you maintain a large set of meter configurations but want
to start wmbusmeters from a cronjob regularly. You can also add oneshot=true
and/or exitafter=30m to the conf file to get the same result.
Krzysztof Lewandowski added support for multiple tariffs in the amiplus driver. Thanks Krzysztof!
Bibo added support for the itron water meter. Thanks Bibo!
Probutus added support for the heat meter Zenner Celsius C5 ISF. Thanks Probutus!
Added MicroClima heat meter.
MaxPeal helped add ANYID as a synonym for '*' when listening to any meter id.
This helps when invoking wmbusmeters from another shell and we want to avoid
escaping '*' multiple levels. Thanks Max!
Refactor driver source code structure. It is now much easier to add a new driver.
DomAtHome added support for the heat meter sharky774. Thanks DomAtHome!
Version 1.6.0 2022-01-01
New year triggered a change to the apator162 telegram. This is now fixed.
DenysFrasinich improved the multical302 driver to handle meters configued to send MegaJoules. Thanks Denys!
Olli Salonen added support for the Zenner Minomess water meter. Thanks Olli!
Now any DLL crcs (frame A or B) are removed automatically
when telegrams are read from a simulation_... file or
passed as hex on the command line. If the DLL crc do not
check out (usually because they are not there), then the
telegram is kept as is. If the crcs are broken because
of a bad data, then the telegram will be passed on as is,
probably causing a bad parse later on.
Added multical602 heat meter.
Version 1.5.0 2021-11-06
Close a security hole where you could trivially spoof an encrypted meter
by sending an unencrypted telegram with the same id.
Fixed a buffer overflow bug triggered by a bad variable length field at the end of a telegram.
Added support for Qundis Q heat 5.5.
Jacek27 added support for the Munia temp/hygrometer. Thanks Jacek27!
Apator162 decoding much improved.
Improved verbose logging to show if you are not in the dialout
group when trying to find dongles. Install now adds the current
user to the dialout group as well.
Added support for the Hydrocal-M3 heating/cooling meter.
Added support for the Apator uniSMART gas meter.
You can now decode a telegram just by supplying hex on the command line:
wmbusmeters --format=json <hex_string> MyMeter auto 12345678 NOKEY
or just
wmbusmeters <hex_string>
Added --listunits to list all quantities and the units for each quantity
that wmbusmeteres knows about.
Tomasz Gramza added manual offset setting to the apator162 meter driver.
You can now specify for example: apator162(offset=29) to use the 4 bytes
at offset 29 in the telegram as the water consumption. Other offsets
known to work for apators are 9,12,20,23. This is useful as a final
resort to get your apator162 readout working. You have to test different
offsets until it works. Thanks Tomasz!
Version 1.4.0 2021-08-09
Fixed a race that sometimes caused wmbusmeters to crash when resetting the dongles,
which happens by default every 23 hours.
Fixed two crashes that could be triggered with broken telegrams. Crashes found by fuzzing.
Improved detection of the amb8465 dongle. The detection code could be confused
if the dongle was receiving a lot of valid telegrams at the same time.
Added telegram content sent by Axioma W1 meter to driver q400,
since Axioma identifies itself as a q400 meter.
You can now add constant fields using --field_extra_info=floor54 and
--selectfields=....,extra_info,.... to print constant values into
the fields format. --field_xxx=yyy is the new name for --json_xxx=yyy.
The old --json_xxx=yyy continues to work for backwards compatibility.
The timestamp field/key is the time registered by wmbusmeters
when the telegram was received. (The telegram itself sometimes
contain another timestamp when the telegram was sent.)
This timestamp field is encoded using the local time when used
in hr/fields (ie "2021-01-01 12:15.00") but UTC time within json
(ie "2021-01-01T10:15.00Z").
This will stay the same. However now you can explicitly select
the timestamp format for the selected fields. Select timestamp_ut
to print the timestamp as a unix timestamp (ie seconds since 1970-01-01).
Select timestamp_utc for the timestamp in UTC and timestamp_lt for local time.
Daniel Glaser added support for the Aventies water meter! Thanks Daniel!
Mblnk added support for Qundis QWater5.5. Thanks Mblnk!
Support added for the water meter Diehl IZAR RC I G4.
Version 1.3.0 2021-04-09
You can now use "auto" as a meter driver.
Wmbusmeters will then pick the right driver when
the first telegram arrives. A warning will be printed
in the logs if no driver could be found.
If you do not specify a type= in the meter config file,
then it will default to auto.
Added --logtimestamps=important/never/always to prefix
a logged line in the log file or stderr output with a timestamp.
Important means timestamp warnings and device changes.
Daemon mode defaults to important.
Added support for firmware version 0x14 for im871a dongle.
(The old version is 0x13 and you can see the firmware version if
you run with --verbose.) The new version of the im871a firmware
supports listening to c1 and t1 at the same time.
Version 1.2.0 2021-03-07
IMPORTANT CHANGES THAT MIGHT AFFECT YOU!vvvvvvvvvvvvvvvvvvvvvv
wmbusmeters now expects the latest version of rtl_wmbus with -s support.
The default behaviour is to use -s to listen to S1,T1 and C1 at the same time.
Check the README for more info.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Rattinca helped add support for the EI Electronics smoke detector. Thanks Rattinca!
Ignore duplicates is now enabled by default. Turn it off with --ignoreduplicates=false
Fixed problem with state maintaining meter drivers and wildcard ids.
A HCA driver was producing telegrams with values that jumped up and down.
This was due to the fact that the meter state in the driver was updated
through multiple different telegrams (this is how the meter works).
Clearly a single state object could not properly maintain the state for all
possible meters matching the wildcard, the state became a random mix
of whatever telegrams arrived.
The fix now, is that a meter C++ object for a uniqe id (not wildcard)
is created only when the first telegram arrives that matches the wildcard.
Thus each meter will have its own C++ object, in which the correct state
is maintained.
Version 1.1.0 2021-02-20
Vincent Privat added code for properly decoding several types of izar meter.
He also added full support for the heat meter sharky 775!
Thanks Vincent!
IMPORTANT CHANGES THAT MIGHT AFFECT YOU!vvvvvvvvvvvvvvvvvvvvvv
Important! Since the new code decodes the correct meter id from the izar
telegrams, therefore your current izar meter setup will break! You have
to update your meter files with the new id. The id is still not
the id that is printed on the meter. However, the numbers that are
printed on the meter are now available in the json eg:
"prefix":"H19CA","serial_number":"026273" which makes it easier
for you to find the proper meter id to listen to.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Added support for telegrams with different dll id vs tpl id.
Such telegrams can be generated when a standalone radio converter
(with its own id) is attached to an mbus meter (with its own id).
Ie there are two distinct ids. The id specified to wmbusmeters will
be now tried both against the dll id and the tpl id, previously
it was only tried against the dll id.
IMPORTANT CHANGES THAT MIGHT AFFECT YOU!vvvvvvvvvvvvvvvvvvvvvv
Important! The meter id reported in the json "id":"........" will
now always be the tpl id, if such an id was part of the telegram.
For most meters this is not a problem, but if you have a standalone
radio converter, or a meter with a wmbus plugin (radio converter meter side),
then you might get a different id.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Added support for the Apator Elf heat meter.
Version 1.0.5 2021-01-30
Xael South added support for the Gran-System-S electricity meters!
Thanks Xael!
Added support for evo868 water meter addon module.
Added support for whe542 heat cost allocator.
Marc Kolly improved the Waterstar meter and added better error codes
and another type/version detection combo! Thanks Marc!
Janus Bo Andersen fixed the omnipower driver! Thanks Janus!
Version 1.0.4 2020-12-05
Nikodem added support for Multical803! Thanks Nikodem!
Added a warning to be printed if an rtl_sdr dongle is found when using auto
and either rtl_sdr or rtl_wmbus cannot be found in the path at startup.
Cinemarene added support for the Techem MK Radio 4 water meter.
Thanks Cinemarene!
Mira added support for Elster V200H water meter and the Elster Merlin 868 addon.
Thanks Mira!
Version 1.0.3 2020-11-11
Add missing files and update man page for --nodeviceexit
Version 1.0.2 2020-11-11
Fixed bug that prevented rtlwmbus[1234] from working.
Fixed a race that in one out of 100 runs, ignored a telegram
on stdin and exited without decoding it.
Wmbusmeters now warns if you have specified /dev/ttyUSB0:im871a:c1
but there is no /dev/ttyUSB0 or if there is an amb8465 on /dev/ttyUSB0.
Added --nodeviceexit
This option will force wmbusmeters to exit if no wmbus device is found.
For example if you specify /dev/ttyUSB0:im871a:c1 and you want
wmbusmeters to fail if there is no im871a on ttyUSB0.
Added --donotprobe=/dev/ttyUSB0
(Also made sure that specifying only rtlwmbus/rtl433 will not probe
serial ttys. Specifying fully specified devices like
/dev/ttyUSB0:im871a:c1 will also not probe the other serial ttys.
Only specifying auto or a generic device type im871a that requires a
serial tty, will probe the serial devices, exluding donotprobe ones.)
Added support for the sontex868 heat cost allocator.
Jacek27 added support for the Ultrimis water meter.
Thanks Jacek27!
psxde added support for the Sensostar 2 heat meter.
Thanks psxde!
Version 1.0.1 2020-10-26
Fix bug that prevented /dev/ttyUSB0:im871a:c1 to work.
Fix bug in install.sh that did not add wmbusmeters to the plugdev group.
Add --ignoreduplicates (ignoreduplicates=true) to ignore
any duplicates. It remembers a history of 10 telegrams.
This is useful when you have multiple dongles for covering
a larger area of reception, but sometimes telegrams arrive
at multiple dongles at the same time.
Add proper support for FlowIQ2200 water meter.
Decode two vendor values in multical603 as energy forward and returned.
Accept t1 and c1 as linkmodes for multical21 meters.
Version 1.0.0 2020-10-25
IMPORTANT CHANGES THAT MIGHT AFFECT YOU!
** BREAKING No udev rules
Wmbusmeters new default behaviour is to never exit if no wmbus
device is found. It stays running all the time even if no
wmbus device is detected. As soon as a device is inserted
it will detect/configure and start using the device.
(When reading stdin and files, then wmbusmeters will of course exit
as soon as there is no more data or stdin is closed.)
This means that the udev rules no longer are needed and must be
removed. This will be done automatically by the install script.
** BREAKING The background rtlwmbus/rtl433 command must be wrapped in CMD(...)
If you used your own command xxx to start rtlsdr+rtlwmbus then that command
was previously supplied like this rtlwmbus:xxx
You must now type rtlwmbus:CMD(xxx)
** There is a possibility to identify some dongles with their id.
The im871a/amb8465/rtlsdr dongles have an id. This id is printed when
wmbusmeters starts using the dongle. You can later use the same id to
configure different dongles for different frequencies and link modes.
You could for example have one rtlsdr dongle with an antenna tuned for 434 MHz
and use set the id of that dongle to dongleALFA (rtl_eeprom -s dongleALFA)
likewise for 868.95 MHz. Then you can start your two dongles at the same time:
wmbusmeters rtlwmbus[dongleALFA]:434M rtlmbus[dongleBETA]:868M
The full specification of a wmbus device is this:
tty/file/stdin : type [ id ] : bps : fq : linkmodes : command
Not all values are relevant for all dongles though.
** Use stderr for logging, stdout for data.
wmbusmeters now uses STDERR as default for info/verbose/debug/trace output.
This will not affect you if you run wmbusmeters as a daemon,
but if you start wmbusmeters yourself you should check where stderr is going.
To use the old style add --usestdoutforlogging.
** New features
To list the shell envs for a meter do --listenvs=multical21
To list the fields avilable for a meter do --listfields=multical21
To list all meters do --listmeters
To search for a meter do --listmeters=water or --listmeters=multi
The wmbus device used to received the telegram and the rssi level
is part of the json, eg: "device":"rtlwmbus[1234]","rssi_dbm":-47
Version 0.9.36 2020-09-08
Added support for detection of the proper driver
based on the manufacturer, media and version fields in the telegram.
This driver is printed when listening without specifying any meters.
The driver will be reported as unknown! for meters not yet supported by wmbusmeters.
Avandorp added support for the AquaMetro / Integra Topas Es Kr water meter.
Thanks Avandorp!
IzeCube added the Techem Compact V heatmeter!
Thanks IzeCube! Though we still need an example telegram for
testing this meter to prevent regressions. So it is currently
not as well supported as the other meters.
Version 0.9.35 2020-08-23
Added support for alarms (shell command triggered)
and resetting of dongle when no telegrams have been received
for a preset time, or if there are communication errors
with the dongle.
Added support for the Waterstar M meter.
Bug fix for long term problem where wmbusmeters did not properly
shut down background rtl_sdr|rtl_wmbus pipeline.
Eric added support for the Multical 403. Thanks Eric!
Bibo made snapcraft fixes. The snap now builds properly! Thanks Bibo!
Version 0.9.34 2020-07-09
Wmbusmeters should now properly handle
partially encrypted telegrams in mode 5 and 7.
The docker image now builds rtl_wmbus from the weetmuts
fork.
Bibo supplied code to auto-update the Docker hub README.
Version 0.9.33 2020-07-01
Bibo made docker fixes. Now rtl_sdr, rtl_wmbus
and rtl_433 are part of the docker image. Thanks Bibo!
Version 0.9.32 2020-06-30
Added support for the Lansen Smoke detector, Door/Window sensor
and Pulse counter.
The tool wmbusmeters-admin can now factory reset your amb8465 dongle.
Version 0.9.31 2020-05-09
You can add comments in the conf and meter files.
A comment is a line that starts with #.
When using --format=fields you can now supply
--selectfields=id,total_m3 to print only the selected fields.
Run with --listfields to see all the avilable fields from a meter.
Improvements in the izar driver. Thanks Erwan!
Bug fixes in the amd8465 driver. Thanks Henry N.!
Version 0.9.30 2020-04-22
Erwan added support for building on FreeBSD. Thanks Erwan!
Version 0.9.29 2020-04-03
Re-add the wmbusmeters.service file so
that the daemon can be easily started without
udev rules. Check the README.
Version 0.9.28 2020-03-08
Improved docker work, thanks Bibo!
Better shell scripts for installing and daemon mode,
in preparation for rpm packaging. Thanks Damian!
Version 0.9.27 2020-02-26
Added support for the apator08 meter.
Fixed important bug that caused rtl_sdr to hang
when daemon was stopped/restarted.
Added support for both T1 and S1 modes for the CUL-dongle.
Added helpful messages when startup of daemon using rtl_wmbus
fails because /usr/bin/rtl_sdr or /usr/bin/rtl_wmbus are missing.
Version 0.9.26 2020-02-07
Cinemarene added support for the Techem
FHKV Data III heat cost allocator. Thanks cinemarene!
Version 0.9.25 2020-02-07
Fix bug i esyswm and ebzwmbe that printed zero values
for phase 2 and 3.
Version 0.9.24 2020-02-06
Added the electricity meter eBZ wMB-E01 (ebzwmbe)
Fixed bugs with detecting the wmbus dongles.
Fixed bug in im871a driver that could
get out of sync and never receive any more telegrams.
Version 0.9.23 2020-02-02
Added the electricity meters:
ESysWM-20 (esyswm) from EasyMeter
eHZ Generation P (ehzp) from EMH Metering
Added the water meter:
Q400 (q400) from Axis Industries.
Fixed a bug in the auto-start from udev that
prevented rtlsdr/rtlwmbus to work properly.
Version 0.9.22 2020-01-19
Bibo added docker support. Thanks Bibo!
Checkout https://hub.docker.com/repository/docker/weetmuts/wmbusmeters
Version 0.9.21 2020-01-19
Michal Bursa helped improve detection of a failing USB device
and added support for automatically starting multiple wmbusmeters
daemons if several dongles are inserted at the same time.
Thanks Michal!
Note! The wmbusmeters.service file is replaced with wmbusmeters@.service
and the contents of the udev file is changed. The install script
will properly install the new files and copy the old ones to ~/old.xxxx.backup files,
and tell the user how to reload the systemd and udev daemons.
Version 0.9.20 2019-12-11
Added support for meterfilestimestamp
to get the effect of log rotation of the meter files.
Version 0.9.19 2019-11-26
Chester4444 added support for the nanoCUL usb stick. Thanks chester4444!
Michal added a utility program (kem-import.py) to import KEM files. Thanks Michal!
Added support for the Diehl HYDRUS watermeter.
Added proper support for Multical302.
Version 0.9.18 2019-11-10
Jacek added support for the Sappel/IZAR 868 meter. Thanks Jacek!
Version 0.9.17 2019-11-03
Thanks to afl-fuzz I found and added
some (in retrospect pretty obvious)
missing checks to deal with
corrupted telegrams that crashed
wmbusmeters.
Now afl-fuzz does not trigger any crash
after running for a couple of minutes.
Lets fuzz more....
Version 0.9.16 2019-11-03
Significant rewrite of serial.cc.
WMBusmeters can now specify stdin as <device>
and continuously read wmbus frames from stdin.
Either raw, or rtlwmbus formatted if stdin:rtlwmbus
is supplied as the <device>. Check the README for
more additions.
Version 0.9.15 2019-10-20
Added Bmeter (rfmamb) and Lansen room sensors (lansenth).
Added support for the rfmrx2 dongle.
Added rawtty (eg /dev/ttyUSB0:38400) support for dongles
that only transmit raw telegrams on the serial port.
Added the ability to add static json data tailored for the meter.
Version 0.9.14 2019-09-16
Added negative match rule for ids. You can now write:
id=78*,!7812345*,!78222222
which will match any meter whose id begins with 78
but not match any meter whose id begins with 7812345,
nor the meter with the exact id 78222222.
The order of the match rules does not matter.
Version 0.9.13 2019-08-14
Fix bug that prevented rtl_wmbus to run inside daemon.
Version 0.9.12 2019-08-12
Added experimental detection for apator162 where the total water consumption
is located within the proprietary data.
Version 0.9.11 2019-06-20
Added --meterfilesnaming=(name|id|name-id)
to choose the file name written meter file.
Naming using id or name-id is necessary when a meter
specification listens to many different meters using id
wildcards.
Version 0.9.10 2019-06-13
Update logrotate to trigger HUP when rotating log files.
This will re-initialize the serial connection to the usb dongle
and reload the config files as well.
Added reload command to systemctl.
Version 0.9.9 2019-06-11
Added support for the signal HUP to trigger wmbusmeters(d)
to reload config files.
Added significantly better tracking of listening modes (C1,T1,S1 etc)
and notify the user if the wmbusmeters configuration would not hear
certain meters specified.
The apator162 meter can send either on c1 or t1. Thus if you have