LimeSDR output: documentation

plugins/samplesink/limesdroutput/readme.md

@@ -0,0 +1,126 @@
+<h1>LimeSDR output plugin</h1>
+
+<h2>Introduction</h2>
+
+This output sample sink plugin sends its samples to a [LimeSDR device](https://myriadrf.org/projects/limesdr/). LimeSDR support in SDRangel is for Linux only.
+
+LimeSDR is a 2x2 MIMO device so it has two transmitting channels that can run concurrently. To activate the second channel when the first is already active just open a new sink tab in the main window (Devices -> Add sink device) and select the same LimeSDR device.
+
+<h2>Build</h2>
+
+The plugin will be built only if LimeSuite is installed in your system. To build and install LimeSuite from source do:
+
+  - `sudo apt-get install libsqlite3-dev`
+  - `git clone https://github.com/myriadrf/LimeSuite.git`
+  - `cd LimeSuite`
+  - `mkdir builddir`
+  - `cd builddir`
+  - `cmake -DCMAKE_INSTALL_PREFIX=/opt/install/LimeSuite`
+  - `make -j8`
+  - `make install`
+
+Then add the following defines on `cmake` command line:
+
+`-DLIMESUITE_INCLUDE_DIR=/opt/install/LimeSuite/include -DLIMESUITE_LIBRARY=/opt/install/LimeSuite/lib/libLimeSuite.so`
+
+<h2>Installation from binary packages</h2>
+
+Packages are provided in the releases section for AMD64 architecture only in the form of .deb files. Support for LimeSDR has to be installed as a prerequisite to installing SDRangel from the .deb package.
+
+The following packages are provided with SDRangel binary distribution:
+
+  - `liblimesuite17.02-1_17.02.1-1_amd64.deb`
+  - `liblimesuite-dev_17.02.1-1_amd64.deb`
+  - `limesuite-udev_17.02.1-1_amd64.deb` (if you want the udev rules)
+
+Alternatively you can install a full LimeSuite from PPA following [these instructions](http://wiki.myriadrf.org/Lime_Suite).
+
+<h2>Interface</h2>
+
+![LimeSDR output plugin GUI](../../../doc/img/LimeSDROutput_plugin.png)
+
+<h3>1: Start/Stop</h3>
+
+Device start / stop button. 
+
+  - Blue triangle icon: device is ready and can be started
+  - Red square icon: device is running and can be stopped
+  - Magenta (or pink) square icon: an error occured. In the case the device was accidentally disconnected you may click on the icon to stop, plug back in, check the source on the sampling devices control panel and start again.
+  
+<h3>2: Baseband sample rate</h3>
+
+This is the baseband sample rate in kS/s before interpolation (4) to produce the final stream that is sent to the LimeSDR device. Thus this is the device sample rate (6) divided by the interpolation factor (4).
+  
+<h3>3: Frequency</h3>
+
+This is the center frequency of transmission in kHz.
+
+<h3>4: Channel number</h3>
+
+LimeSDR is a 2x2 MIMO device so it has two transmitting channels. This shows the corresponding Tx channel index (0 or 1).
+
+<h3>5: NCO toggle</h3>
+
+The button is lit when NCO is active and dark when inactive.
+
+Use this button to activate/deactivate the TSP NCO. The LMS7002M chip has an independent NCO in each Tx channel that can span the bandwidth sent to the DAC. This effectively allows non zero digital IF.
+
+<h3>6: Zero (reset) NCO frequency</h3>
+
+USe this push button to reset the NCO frequency to 0 and thus center on the main passband of the DAC.
+
+<h3>7: Center frequency with NCO engaged</h3>
+
+This is the center frequency of the mix of LO and NCO combined and is the sink passband center frequency when the NCO is engaged. Use the thumbwheels to adjust frequency as done with the LO (1.1). The boundaries are dynamically calculated from the LO center frequency and sample rate.
+
+<h3>8: LMS7002M hardware interpolation factor</h3>
+
+The TSP block in the LMS7002M hardware has an interpolation chain that acts on both Tx channels. It is composed of 5 halfband interpolation stages and therefore can achieve interpolation between 1 (no interpolation) and 32 in increasing powers of 2: 1, 2, 4, 8, 16, 32.
+
+Thus the actual sample rate of the DAC is the stream sample rate (10) multiplied by this factor. 
+
+<h3>9: Software interpolation factor</h3>
+
+The I/Q stream from the LimeSDR is upsampled by a power of two by software inside the plugin before being sent to the device. Possible values are increasing powers of two: 1 (no interpolation), 2, 4, 8, 16, 32.
+
+<h3>10: Device stream sample rate</h3>
+
+This is the LMS7002M device to/from host stream sample rate in S/s.
+
+Use the wheels to adjust the sample rate. Left click on a digit sets the cursor position at this digit. Right click on a digit sets all digits on the right to zero. This effectively floors value at the digit position. 
+
+The LMS7002M uses the same clock for both the ADCs and DACs therefore this sample rate affects all of the 2x2 MIMO channels.
+
+<h3>11: Tx hardware filter bandwidth</h3>
+
+This is the Tx hardware filter bandwidth in kHz in the LMS7002M device for the given channel. Boundaries are updated automatically but generally are from 5 to 130 MHz in 1 kHz steps. Use the wheels to adjust the value.
+
+<h3>12: TSP FIR filter toggle</h3>
+
+The TSP in the LMS7002M chip has a FIR filter chain per channel. Use this button to activate or deactivate the TSP FIR filter.
+
+<h3>13: TSP FIR filter bandwidth</h3>
+
+USe the wheels to adjust the bandwidth of the hardware TSP FIR filter.
+
+<h3>14: Gain</h2>
+
+Use this slider to adjust the global gain of the Tx chain. LimeSuite software automatically set optimals values of the amplifiers to achive this global gain. This gain can be set between 0 and 70 dB in 1 dB steps. The value in dB appears at the right of the slider. 
+
+<h3>15: Stream status indicator</h3>
+
+This label turns green when status can be obtained from the current stream. Usually this means that the stream is up and running but not necessarily streaming data. The various status elements appear next on the same line (16, 17, 18)
+
+<h3>16: Stream warning indicators</h3>
+
+  - **U**: turns red if stream experiences underruns
+  - **O**: turns red if stream experiences overruns  
+  - **P**: turns red if stream experiences packet drop outs
+  
+<h3>17: Stream global (all Tx) throughput in MB/s</h3>
+
+This is the stream throughput in MB/s and is usually about 3 times the sample rate for a single stream and 6 times for a dual Tx stream. This is due to the fact that 12 bits samples are used and although they are represented as 16 bit values only 12 bita travel on the USB link.
+
+<h3>18: FIFO status</h3>
+
+This is the fill percentage of the Tx FIFO in the LimeSuite interface. There is no flow regulation provided by the LimeSuite interface so an automatic adjustment is done within the plugin. In practice the value will oscillate between 50 and 100% centered around 80%.

plugins/samplesource/limesdrinput/readme.md

@@ -88,17 +88,19 @@ These buttons control the local DSP auto correction options:
   - **DC**: (6) auto remove DC component
   - **IQ**: (7) auto make I/Q balance
   
-<h3>8: LMS7002M hardware decimation</h3>
+<h3>8: LMS7002M hardware decimation factor</h3>
 
 The TSP block in the LMS7002M hardware has a decimation chain that acts on both Rx channels. It is composed of 5 halfband decimation stages and therefore can achieve decimation between 1 (no decimation) and 32 in increasing powers of 2: 1, 2, 4, 8, 16, 32.
 
+Thus the actual sample rate of the ADC is the stream sample rate (10) multiplied by this factor. 
+
 <h3>9: Software decimation factor</h3>
 
 The I/Q stream from the LimeSDR is doensampled by a power of two by software inside the plugin before being sent to the passband. Possible values are increasing powers of two: 1 (no decimation), 2, 4, 8, 16, 32.
 
-<h3>10: Device sample rate</h3>
+<h3>10: Device stream sample rate</h3>
 
-This is the LMS7002M device ADC and DAC sample rate in S/s.
+This is the LMS7002M device to/from host stream sample rate in S/s.
 
 Use the wheels to adjust the sample rate. Left click on a digit sets the cursor position at this digit. Right click on a digit sets all digits on the right to zero. This effectively floors value at the digit position.