diff --git a/README.md b/README.md index 55d4aba..28338fb 100644 --- a/README.md +++ b/README.md @@ -193,10 +193,12 @@ depending on if you are running as a daemon or not. # Running without config files, good for experimentation and test. ``` -wmbusmeters version: 1.4.0 -Usage: wmbusmeters {options} ( [meter_name] [meter_driver]{:} [meter_id] [meter_key] )* +wmbusmeters version: 1.6.0 +Usage: wmbusmeters {options} [device] { [meter_name] [meter_driver] [meter_id] [meter_key] }* + wmbusmeters {options} [hex] { [meter_name] [meter_driver] [meter_id] [meter_key] }* + wmbusmetersd {options} [pid_file] -As you can use: +As {options} you can use: --addconversions=+ add conversion to these units to json and meter env variables (GJ) --alarmexpectedactivity=mon-fri(08-17),sat-sun(09-12) Specify when the timeout is tested, default is mon-sun(00-23) diff --git a/deb/collect_copyrights.sh b/deb/collect_copyrights.sh index b478d05..44a0146 100755 --- a/deb/collect_copyrights.sh +++ b/deb/collect_copyrights.sh @@ -70,5 +70,6 @@ License: CC0 EOF mv $TMP $1 +chmod 644 $1 echo "Created copyright file: $1" diff --git a/deb/create_deb.sh b/deb/create_deb.sh index 4fee446..0fa86aa 100755 --- a/deb/create_deb.sh +++ b/deb/create_deb.sh @@ -7,25 +7,37 @@ DEBARCH=$4 if [ -z "$BUILD" ] then - echo You must supply a directory for the deb contents. + echo "You must supply a directory for the deb contents." + exit 1 +fi + +if [ ! -x "$BUILD/wmbusmeters" ] +then + echo "You have to build wmbusmeters first." + exit 1 +fi + +if [ "$USER" != "root" ] +then + echo 'You have to run this command as "sudo make deb"' exit 1 fi if [ -z "$DEB" ] then - echo you must supply a name for the deb file. + echo "Uou must supply a name for the deb file." exit 1 fi if [ -z "$DEBVERSION" ] then - echo you must supply deb version. + echo "You must supply deb version." exit 1 fi if [ -z "$DEBARCH" ] then - echo you must supply a deb arch. + echo "You must supply a deb arch." exit 1 fi diff --git a/wmbusmeters.1 b/wmbusmeters.1 index 30ec7a5..38ec4ed 100644 --- a/wmbusmeters.1 +++ b/wmbusmeters.1 @@ -1,22 +1,23 @@ .TH WMBUSMETERS 1 .SH NAME -wmbusmeters \- listen to wireless mbus radio traffic and relay the decoded telegrams to other software +wmbusmeters \- Acquire,query and decode wired and wireless mbus telegrams, then relay the telegrams to other software. .SH SYNOPSIS -.B wmbusmeters [options] {:suffix} ( [:] meter_key>)* +.B wmbusmeters {options} [device] { [name] [driver] [id] [key] }* -.B wmbusmeters [options] ( [:] meter_key>)* +.B wmbusmeters {options} [hex] { [name] [driver] [id] [key] }* -.B wmbusmetersd +.B wmbusmetersd {options} [pid_file>] .SH DESCRIPTION Wmbusmeters acquires wmbus telegrams, decodes them and relays them to some other software for further processing. It can for example listen -to radio traffic using dedicated wmbus dongles like (im871a,amb8465,cul,rc1180) -or a generic software defined radio dongle (rtl_sdr) with an RTL2832U. +to radio traffic using dedicated wmbus dongles (eg im871a,amb8465,cul,rc1180) +or a software defined radio dongle (rtl_sdr) with an RTL2832U (decoded using +rtl_wmbus, rtl_433). -After the received telegram has been decrypted and parsed, it can then +After the acquired telegram has been decrypted and parsed, it can then be relayed using a shell command, or stored in a log file. The shell commands can for example relay the telegram using MQTT (eg mqtt_publish) sent to a REST API (eg curl) or store it in a database @@ -33,6 +34,13 @@ mqtt_publish) sent to a REST API (eg curl) or store it in a database \fB\--analyze\fR Analyze a telegram to find the best driver +\fB\--analyze=\fR Analyze a telegram to find the best driver and use the provided decryption key. + +\fB\--analyze=\fR Analyze a telegram but use only this driver. + +\fB\--analyze=\fR: Analyze a telegram and use only this driver with this key. +Add :verbose to any analyze to get more verbose analyze output. + \fB\--debug\fR for a lot of information \fB\--device=\fR override device in config files. Use only in combination with --useconfig= option