diff --git a/README.md b/README.md index a06d6138..ae8d42a4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -rtl_433 -======= +# rtl_433 rtl_433 (despite the name) is a generic data receiver, mainly for the 433.92 MHz, 868 MHz (SRD), 315 MHz, and 915 MHz ISM bands. @@ -8,22 +7,19 @@ The official source code is in the https://github.com/merbanan/rtl_433/ reposito It works with [RTL-SDR](https://github.com/osmocom/rtl-sdr/) and/or [SoapySDR](https://github.com/pothosware/SoapySDR/). Activly tested and supported are Realtek RTL2832 based DVB dongles (using RTL-SDR) and LimeSDR ([LimeSDR USB](https://www.crowdsupply.com/lime-micro/limesdr) and [LimeSDR mini](https://www.crowdsupply.com/lime-micro/limesdr-mini) engineering samples kindly provided by [MyriadRf](https://myriadrf.org/)), PlutoSDR, HackRF One (using SoapySDR drivers), as well as SoapyRemote. - + -Building/installation: ----------------------- +## Building/installation See [BUILDING.md](BUILDING.md) Official [binary builds for Windows](https://bintray.com/chzu/dist/rtl_433) (32 and 64 bit) are available at Bintray. -How to add support for unsupported sensors ------------------------------------------- +## How to add support for unsupported sensors Read the Test Data section at the bottom. -Running: --------- +## Running rtl_433 -h @@ -355,8 +351,7 @@ Some examples: | `rtl_433 -f 433.53M -f 434.02M -H 15` | Will poll two frequencies with 15 seconds hop interval. -Supporting Additional Devices and Test Data -------------------------------------------- +## Supporting Additional Devices and Test Data Some device protocol decoders are disabled by default. When testing to see if your device is decoded by rtl_433, use `-G` to enable all device protocols. @@ -392,15 +387,13 @@ until you've added test signals and the description to the repository. The rtl_433_test repository is also used to help test that changes to rtl_433 haven't caused any regressions. -Google Group ------------- +## Google Group Join the Google group, rtl_433, for more information about rtl_433: https://groups.google.com/forum/#!forum/rtl_433 -Troubleshooting ---------------- +## Troubleshooting If you see this error: diff --git a/examples/README.md b/examples/README.md index 18139bb8..308152d2 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,4 @@ # rtl_433 examples -================== Some example readers/relays for rtl_433 JSON UDP data. Should work with Python 2 and also Python 3. @@ -7,14 +6,10 @@ Consider using PEP 3143 - Standard daemon process library or run with Supervisor The `pipe` examples read JSON output from `rtl_433` using a pipe, i.e. -``` -rtl_433 -F json ... | rtl_433_statsd_pipe.py -```` + rtl_433 -F json ... | rtl_433_statsd_pipe.py The `relay` examples consumes the (UDP) Syslog output from rtl_433 (or a legacy plain JSON datagram). Basically run `rtl_433` with `-F syslog:127.0.0.1:1433` and the relay script as an unrelated process, i.e. -``` -rtl_433_mqtt_relay.py & -rtl_433 -F syslog:127.0.0.1:1433 -```` + rtl_433_mqtt_relay.py & + rtl_433 -F syslog:127.0.0.1:1433 diff --git a/vs15/README.md b/vs15/README.md index 6c3ddd6f..b6c69e85 100644 --- a/vs15/README.md +++ b/vs15/README.md @@ -1,5 +1,5 @@ -Compilation instructions -=========== +# Compilation instructions for VS15 + To compile the program in Visual Studio 2015 (newer versions should work as well), you first need to extract the rtl-sdr library into a folder "rtl-sdr" parallel to the rtl_433_win folder. You can use the official, but outdated (January 2014)) windows build https://osmocom.org/attachments/2242/RelWithDebInfo.zip