Update README.md

README.md

@@ -7,6 +7,20 @@ The license is LGPLv3.
 
 The project contains a set of Python tools for the automatic code generation of modules for popular SDR frameworks, including GNURadio, ALOE++, IRIS, and OSSIE. These tools are easy to use and adapt for generating targets for specific platforms or frameworks. 
 
+Current Status
+===============
+
+The following parts are available:
+ * Physical Broadcast channel (PBCH) eNodeB and UE part. The UE supports multi-antenna transmitters
+ * Synchronization and CFO estimation/correction
+ * Equalization
+ * UE receiver verified with live LTE signals
+
+Hardware
+========
+
+The library currently uses Ettus Universal Hardware Driver (UHD). Thus, any hardware supported by UHD can be used. There is no sampling rate conversion, therefore the hardware should support 30.72 MHz clock in order to work correctly with LTE sampling frequencies and decode signals from live LTE base stations. 
+
 Support
 ========
 
@@ -16,6 +30,8 @@ Mailing list: https://lists.sourceforge.net/lists/listinfo/liblte-users
 Download & Install Instructions
 =================================
 
+* Requirements: Currently, the library requires libfftw, although we plan make this dependency optional in the future. Also, QT4 and Qwt6 are needed for graphics visualization. If they are not present, though, compilation is still possible although graphics will be disabled. 
+
 ```
 git clone https://github.com/ismagom/libLTE.git
 cd libLTE
@@ -23,42 +39,40 @@ mkdir build
 cd build
 cmake ../
 make 
-sudo make install
 ```
 
-Cell Search Example
-====================
-
-This program uses any hardware supported by the UHD driver to scan an LTE band for active cells. See http://niviuk.free.fr/lte_band.php for a list of available bands. The program first obtains a power spectral density of the entire band. For all frequencies with an RSSI higher than a threshold, it tries to find the LTE Primary Synchronization Signal (PSS) and then identifies the CELL ID using the Secondary Synchronization Signal (SSS). Finally, it estimates the Carrier Frequency Offset (CFO) and Sampling Frequency Offset (SFO). 
+The library can also be installed using the command ```sudo make install```. 
 
-For instance, the command:
+Examples
+==========
 
-``` pss_scan_usrp -b 3 ```
+* eNodeB and UE PBCH example
 
+Setup one or two computers connected to two USRP or UHD-compatible hardware. From the eNodeB, type
 
-Scans the LTE band 3 (1805 to 1880 MHz). Note that you need a hardware supporting these frequencies (e.g. SBX daughterboard for USRP). The program outputs the following:
+```
+examples/enodeb_bch -f [frequency_in_Hz] -c [cell_id] [-a [UHD args]] [-h for more commands]
+```
 
+From the UE, type 
 ```
-Opening UHD device...
--- Opening a USRP2/N-Series device...
--- Current recv frame size: 1472 bytes
--- Current send frame size: 1472 bytes
-RSSI scan: 749 freqs in band 3, RSSI threshold -30.00 dBm
-Freq 1879.0 Mhz - RSSI: -43.96 dBm
-Done. Starting PSS search on 75 channels
-
-UHD Warning:
-    The hardware does not support the requested RX sample rate:
-    Target sample rate: 1.920000 MSps
-    Actual sample rate: 1.923077 MSps
-[199/749]: EARFCN 1399 Freq. 1824.90 MHz No PSS found
-[200/749]: FOUND EARFCN 1400 Freq. 1825.00 MHz, RSSI -22.43 dBm, PAR 15.86 dB, CFO=-0.25 KHz, SFO=+3.099 KHz, CELL_ID=150
-[433/749]: EARFCN 1633 Freq. 1848.30 MHz No PSS found
-
-Done
+examples/mib_track -f [frequency_in_Hz] -c [cell_id] [-a [UHD args]] [-h for more commands]
 ```
 
-indicating that a Cell with ID 150 has been found at 1825.0 MHz. PAR indicates the peak-to-average ratio (in dB) at the output of the PSS correlator. 
+And the output should look something like the following video. In this example, we removed the transmitter and receiver antennas in the middle of the demonstration, showing how reception is still possible (despite with some erros). 
+
+https://www.dropbox.com/s/txh1nuzdb0igq5n/demo_pbch.ogv
+
+![Screenshopt of the PBCH example output](pbch_capture.png "Screenshopt of the PBCH example output")
+
+* Cell Search Example
+
+This program uses any hardware supported by the UHD driver to scan an LTE band for active cells. See http://niviuk.free.fr/lte_band.php for a list of available bands. The program first obtains a power spectral density of the entire band. For all frequencies with an RSSI higher than a threshold, it tries to find the LTE Primary Synchronization Signal (PSS) and then identifies the CELL ID using the Secondary Synchronization Signal (SSS). Finally, it estimates the Carrier Frequency Offset (CFO) and Sampling Frequency Offset (SFO) and decodes the Master Information Block (MIB) from the PBCH. 
+
+For instance, the command:
+
+``` examples/mib_scan_usrp -b 3 ```
+
 
-For more command arguments, type ``` pss_scan_usrp --help ```
+Scans the LTE band 3 (1805 to 1880 MHz). Note that you need a hardware supporting these frequencies (e.g. SBX daughterboard for USRP). For more command arguments, type ``` examples/mib_scan_usrp -h ```