Improved README

pull/5/head
weetmuts 2018-03-05 12:21:55 +01:00
rodzic 35b7bc7b30
commit 13c3d6dde7
1 zmienionych plików z 20 dodań i 14 usunięć

Wyświetl plik

@ -34,34 +34,49 @@ If this happens to someone, then we need to implement a way to pass the meter co
No meter quadruplets means listen for telegram traffic and print any id heard.
# Builds and runs on GNU/Linux:
# Usage examples
```
make
./build/wmbusmeters /dev/ttyUSB0 MyTapWater multical21 12345678 00112233445566778899AABBCCDDEEFF
```
wmbusmeters will detect which kind of dongle is connected to /dev/ttyUSB0. It can be either an IMST 871a dongle or an Amber Wireless AMB8465. If you have setup the udev rules below, then you can use auto instead of /dev/ttyUSB0.
Example output:
`MyTapWater 12345678 6.388 m3 6.377 m3 DRY(dry 22-31 days) 2018-03-05 12:02.50`
`./build/wmbusmeters --verbose /dev/ttyUSB0 MyTapWater multical21 12345678 00112233445566778899AABBCCDDEEFF`
Example robot json output:
`./build/wmbusmeters --robot=json auto MyTapWater multical21 12345678 00112233445566778899AABBCCDDEEFF MyHeater multical302 22222222 00112233445566778899AABBCCDDEEFF`
Example robot json output:
`{media:"cold water",meter:"multical21","name":"MyTapWater","id":"12345678","total_m3":6.388,"target_m3":6.377,"current_status":"DRY","time_dry":"22-31 days","time_reversed":"","time_leaking":"","time_bursting":"","timestamp":"2018-02-08T09:07:22Z"}`
`{media:"heat",meter:"multical302","name":"MyHeater","id":"22222222","total_kwh":0.000,"total_volume_m3":0.000,"current_kw":"0.000","timestamp":"2018-02-08T09:07:22Z"}`
Example robot fields output:
`./build/wmbusmeters --robot=fields auto GreenhouseWater multical21 33333333 ""`
Example robot fields output:
`GreenhouseTapWater;33333333;9999.099;77.712;;2018-03-05 12:10.24`
You can use `--debug` to get both verbose output and the actual data bytes sent back and forth with the wmbus usb dongle.
If the meter does not use encryption of its meter data, then enter an empty key on the command line.
(you must enter "")
`./build/wmbusmeters --robot --meterfiles auto MyTapWater multical21 12345678 ""`
You can run wmbusmeters with --logtelegrams to get log output that can be placed in a simulation.txt
file. You can then run wmbusmeter and instead of auto (or an usb device) provide the simulationt.xt
file as argument. See test.sh for more info.
# Builds and runs on GNU/Linux:
`make && make test`
Binary generated: `./build/wmbusmeters`
`make HOST=arm`
Binary generated: `./build_arm/wmbusmeters`
@ -74,15 +89,6 @@ Binary generated: `./build_debug/wmbusmeters`
Binary generated: `./build_arm_debug/wmbusmeters`
If the meter does not use encryption of its meter data, then enter an empty key on the command line.
(you must enter "")
`./build/wmbusmeters --robot --meterfiles /dev/ttyUSB0 MyTapWater multical21 12345678 ""`
You can run wmbusmeters with --logtelegrams to get log output that can be placed in a simulation.txt
file. You can then run wmbusmeter and instead of auto (or an usb device) provide the simulationt.xt
file as argument. See test.sh for more info.
# System configuration
Add yourself to the dialout group to get access to the newly plugged in im871A USB stick.