README.md

   1 rtl_433
   2 =======
   3
   4 rtl_433 turns your Realtek RTL2832 based DVB dongle into a 433.92MHz generic data receiver
   5
   6 Installation instructions:
   7 --------------------------
   8
   9 Compiling rtl_433 requires [rtl-sdr](http://sdr.osmocom.org/trac/wiki/rtl-sdr) to be installed.
  10
  11 Installation using cmake:
  12
  13     cd rtl_433/
  14     mkdir build
  15     cd build
  16     cmake ../
  17     make
  18         make install
  19
  20 Installation using autoconf:
  21
  22     cd rtl_433/
  23     autoreconf --install
  24         ./configure
  25         make
  26         make install
  27
  28
  29 Running:
  30 --------
  31
  32     rtl_433 -h
  33
  34     Usage:  [-d device_index (default: 0)]
  35         [-g gain (default: 0 for auto)]
  36         [-a analyze mode, print a textual description of the signal]
  37         [-l change the detection level used to determine pulses (0-32000) default 10000]
  38         [-f change the receive frequency, default is 433.92MHz]
  39         [-S force sync output (default: async)]
  40         [-r read data from file instead of from a receiver]
  41         filename (a '-' dumps samples to stdout)
  42
  43
  44 Examples:
  45
  46 | Command | Description
  47 |---------|------------
  48 | `rtl_433 -a` | will run in analyze mode and you will get a text log of the received signal.
  49 | `rtl_433 -a file_name` | will save the demodulated signal in a file. The format of the file is 48kHz 16 bit samples.
  50 | `rtl_433` | will run the software in receive mode. Some sensor data can be receviced.
  51
  52 This software is mostly useable for developers right now.
  53
  54 Supported Devices
  55 -----------------
  56
  57     Rubicson Temperature Sensor
  58     Silvercrest Remote Control
  59     ELV EM 1000
  60     ELV WS 2000
  61     Waveman Switch Transmitter
  62     Steffen Switch Transmitter
  63     Acurite 5n1 Weather Station
  64     Acurite Temperature and Humidity Sensor
  65     Acurite 896 Rain Gauge
  66     LaCrosse TX Temperature / Humidity Sensor
  67     Oregon Scientific Weather Sensor
  68     KlikAanKlikUit Wireless Switch
  69     AlectoV1 Weather Sensor
  70     Intertechno 433
  71     Mebus 433
  72
  73 Google Group
  74 ------------
  75
  76 https://groups.google.com/forum/#!forum/rtl_433
  77