aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias P. Braendli <matthias.braendli@mpb.li>2016-07-25 20:30:15 +0200
committerMatthias P. Braendli <matthias.braendli@mpb.li>2016-07-25 20:30:15 +0200
commit6cb14e70a7f2ab6077aa00106e082aa00627057f (patch)
tree8ef1d5199e0a654c26f05f7e5618e6f15324e3ed
parente359479f2ca631686d8c20153dc54b109b917f5b (diff)
downloadodr-dab-cir-6cb14e70a7f2ab6077aa00106e082aa00627057f.tar.gz
odr-dab-cir-6cb14e70a7f2ab6077aa00106e082aa00627057f.tar.bz2
odr-dab-cir-6cb14e70a7f2ab6077aa00106e082aa00627057f.zip
Update readme
-rw-r--r--README.md24
1 files changed, 20 insertions, 4 deletions
diff --git a/README.md b/README.md
index c6377f2..5120d35 100644
--- a/README.md
+++ b/README.md
@@ -15,12 +15,26 @@ Right now there are three scripts:
Each reflexion has a delay and an amplitude factor.
* cir_measure.py: Runs a small webserver that does the correlation
- all the time and updates a webpage (INCOMPLETE! NOT FUNCTIONAL!)
+ all the time and updates a webpage
Example image: ![Example correlation](./example_corr.png)
The image shows the received CIR of a real DAB signal captured with the RTLSDR.
+Webserver
+---------
+
+To run the webserver on all network interfaces, receiving on 202.928MHz:
+
+ ./cir_measure.py --host 0.0.0.0 --port 8080 --freq 202928000
+
+More options are available (gain, number of samples), see the help with
+
+ ./cir_measure.py -h
+
+Offline processing
+------------------
+
To read in a recording using a RTL-SDR receiver, use:
rtl_sdr -f 188928000 -s 2048000 -g 20 -S - | \
@@ -34,13 +48,15 @@ Then feed the data to the script
Requirements
-------------
-Python with NumPy and matplotlib
+============
+librtlsdr and its tools.
+
+Python with NumPy and matplotlib.
The iq files must be complex float or interleaved unsigned 8-bit.
Licence
--------
+=======
MIT. See LICENCE for details.