From 8337ed478df18e5543a56f7b976f3d677618670f Mon Sep 17 00:00:00 2001 From: mattbk Date: Sat, 12 Sep 2026 11:12:05 -0500 Subject: [PATCH] Add readme. --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ee6d85 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# ASMR +ASMR: Automatic S-Meter Reader + +This program reads location from a GPS dongle and the S-Meter from a +transceiver via a serial port and stores the results in a CSV file +so you can run analysis in another program. + +Inspired by "RFIM" by W4DD and written in Rust. +(add a link here to W4DD's RFI materials) + +# Use Cases +- Drive a route and measure variation in noise level, to determine local noise sources +- Record noise level at a fixed location over time, to determine temporal noise patterns +- Some combination of the two + +# Help +``` +asmr --help + +ASMR: Automatic S-Meter Reader + +Usage: asmr [OPTIONS] + +Options: + -r, --rig Output file path [default: qmx] + -c, --com Rig COM port + -g, --gps GPS COM port + -o, --file Output file path + -f, --freq Frequency + -w, --wait Seconds to wait between measurements [default: 5] + -h, --help Print help + -V, --version Print version + ``` + + # Contact + - [@W1CDN@mastodon.radio](https://mastodon.radio/@W1CDN) + - admin@w1cdn.net \ No newline at end of file