aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPiotr Krysik <ptrkrysik@users.noreply.github.com>2014-12-06 18:58:11 +0100
committerPiotr Krysik <ptrkrysik@users.noreply.github.com>2014-12-06 18:58:11 +0100
commit99f33e4a617dee5b8440e97463563373fcc9bfd9 (patch)
treed6203bd0573bd2ed825dd37cd0d36a9d4020b605 /README.md
parent4142285b874efd760bfb1560ec1deeeaf9e5a10b (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md
index 0f2ba1f..b6c80ce 100644
--- a/README.md
+++ b/README.md
@@ -9,17 +9,17 @@ Installation
The project is based on *GNU Radio* signal processing framework and takes advantage of its great features like stream tagging and message passing.
Presence of *GNU Radio* is therefore a basic requirement for compilation and installation of *gr-gsm*.
-The description of the installation uses pybombs (*GNU Radio*'s third party projects installer) and was tested on Ubuntu 14.04 and 14.10.
+Installation is based on *pybombs* installer (GNU Radio install management system) and was tested on Ubuntu 14.04 and 14.10.
For installation you will need git. On Debian based distributions you can get it with:
```
sudo apt-get install git
```
-Then download pybombs sources using git:
+Then download *pybombs* sources using git:
```
git clone https://github.com/ptrkrysik/pybombs.git
```
-Go into pybombs directory and configure it:
+Go into *pybombs* directory and configure it:
```
cd pybombs
./pybombs
@@ -34,7 +34,7 @@ Then build and install *gr-gsm* with following command:
Pybombs will take care of downloading all of required libraries and for installation of *GNU Radio* and building *gr-gsm*.
-*Gr-gsm* blocks that will be later installed will be located in */usr/local* directory. To tell *Gnu Radio Companion* to look for blocks in there create config.conf in *~/.gnuradio* directory (this step is not required on Ubuntu 14.04 as *GNU Radio* will be built from source, will reside in */usr/local* and *GNU Radio* will be already configured to look for *Gnu Radio Companion* blocks in there):
+*Gr-gsm* blocks that are installed in */usr/local* directory. To tell *Gnu Radio Companion* to look for blocks in there create config.conf in *~/.gnuradio* directory (this step is not required on Ubuntu 14.04 as *GNU Radio* will be built from source, will reside in */usr/local* and *GNU Radio* will be already configured to look for *Gnu Radio Companion* blocks in there):
```
mkdir ~/.gnuradio
touch ~/.gnuradio/config.conf
@@ -56,11 +56,12 @@ There are many possible applications of *gr-gsm*. At this moment there is one ap
Airprobe with RTL-SDR input
---------------
-This program uses cheap RTL-SDR receivers as the source of the signal. It can be started by running from a terminal:
+This program uses cheap RTL-SDR receivers as a source of the signal. It can be started by running from a terminal:
```
airprobe_rtlsdr.py
```
The window of the program contains amplitude spectrum of the signal drawn in realtime. The central frequency of the signal can be changed by moving *fc* slider. The GSM signal has bandwidth of around *200kHz*. By looking for constant hills on the spectrum of such width you can find a GSM broadcasting channel. By setting the *fc* slider to a carrier frequency of a broadcasting channel the program should immediately print content of subsequent messages on the standard output.
+
If it doesn't happen set *ppm* slider into different positions. The slider is responsible for setting devices clock offset correction. If the clock offset is too large the clock offset correction algorithm that is implemented in the program won't work. There is intentionally added upper of allowable clock offset - it was done in order to avoid adaptation of the algorithm to neighbour channels that would inevitably lead to instability. You can use the value set later by passing it as argument of the program:
```
airprobe_rtlsdr.py -p <correction>