README improvements, added typical command line

* rtl_433: better description of ppm error option
This commit is contained in:
rct 2015-12-12 19:07:37 -05:00
parent 82919ce87a
commit 396e8462be
2 changed files with 3 additions and 2 deletions

View file

@ -119,7 +119,8 @@ Examples:
| Command | Description
|---------|------------
| `rtl_433` | Will run the software in receive mode. Some sensor data can be received and decoded.
| `rtl_433` | Default receive mode, attempt to decode all known devices
| `rtl_433 -p NN -R 1 -R 9 -R 36 -R 40 | Typical usage: Enable device decoders for desired devices. Correct rtl-sdr tuning error (ppm offset).
| `rtl_433 -a` | Will run in analyze mode and you will get a text description of the received signal.
| `rtl_433 -A` | Enable pulse analyzer. Summarizes the timings of pulses, gaps, and periods. Can be used in either the normal decode mode, or analyze mode.
| `rtl_433 -a -t` | Will run in analyze mode and save a test file per detected signal (gfile###.data). Format is uint8, 2 channels.

View file

@ -85,7 +85,7 @@ void usage(r_device *devices) {
"\t[-d <device index>] (default: 0)\n"
"\t[-g <gain>] (default: 0 for auto)\n"
"\t[-f <frequency>] [-f...] Receive frequency(s) (default: %i Hz)\n"
"\t[-p <ppm_error>] (default: 0)\n"
"\t[-p <ppm_error] Correct rtl-sdr tuner frequency offset error (default: 0)\n"
"\t[-s <sample rate>] Set sample rate (default: %i Hz)\n"
"\t[-S] Force sync output (default: async)\n"
"\t= Demodulator options =\n"