Updated readme with usage examples

master
David Högborg 9 years ago
parent b87faf73ec
commit 6dab423eef

@ -1,3 +1,18 @@
# go-pocsag
A parser for POCSAG pager protocol implemented in Go
A parser for POCSAG pager protocol implemented in Go
## Usage
Read a recorded wav file `gopocsag -i path/to/file.wav`
Listen to stream from rtl_fm: `rtl_fm -f <freq> -E deemp | gopocsag`
Parse a raw datadump: `cat dump.bin | gopocsag`
## Options
* `--type` force message parsing type, one of `auto` `bcd` `alpha`
* `--debug` print debugging and extra information about transmission.
* `--verbosity` regulate the detail of debugging information
## Resource usage
Not much. About 0.2% of a i5 during normal operations. Just above 5 mb of RAM.
Loading…
Cancel
Save