BladeRF2: updated documentation

Readme.md

@@ -100,8 +100,6 @@ It is recommended to add `-DRX_SAMPLE_24BIT=ON` on the cmake command line to act
 
 <h2>BladeRF classic (v.1)</h2>
 
-Linux only.
-
 [BladeRF1](https://www.nuand.com/bladerf-1) is supported through the libbladeRF library that should be installed in your system for proper build of the software and operation support. Add `libbladerf-dev` to the list of dependencies to install. Note that libbladeRF v2 is used since version 4.2.0 (git tag 2018.08).
 
 If you compile and use your own location for libbladeRF install directory you need to specify library and include locations. Example with `/opt/install/libbladerf` with the following defines on `cmake` command line:
@@ -116,7 +114,7 @@ The plugins used to support BladeRF classic are specific to this version of the
 
 <h2>BladeRF micro (v.2)</h2>
 
-Linux only. From version 4.2.0
+From version 4.2.0. Output (Tx) for Linux only.
 
 [BladeRF 2 micro](https://www.nuand.com/bladerf-2-0-micro/) is also supported using libbladeRF library that should be installed and configured in the same way as for BladeRF1.
 

plugins/samplesink/bladerf2output/readme.md

@@ -0,0 +1,116 @@
+<h1>BladeRF 2.0 micro (v2) output plugin</h1>
+
+<h2>Introduction</h2>
+
+This output sample sink plugin sends its samples to a [BladeRF2 device](https://www.nuand.com/bladerf-2). This is available since v4.2.0 in Linux distributions only.
+
+<h2>Build</h2>
+
+The plugin will be built only if the [BladeRF host library](https://github.com/Nuand/bladeRF) is installed in your system. If you build it from source and install it in a custom location say: `/opt/install/libbladeRF` you will have to add `-DLIBBLADERF_INCLUDE_DIR=/opt/install/libbladeRF/include -DLIBBLADERF_LIBRARIES=/opt/install/libbladeRF/lib/libbladeRF.so` to the cmake command line.
+
+Note that the libbladeRF v2 (specifically the git tag 2018.08) is used.
+
+The BladeRF Host library is also provided by many Linux distributions (check its version) and is built in the SDRangel binary releases.
+
+<h2>Multiple Output (MO) mode</h2>
+
+If two device sets one for each Tx channel are opened then the SO/MO mode switch is governed by which channels are effectively streaming. As soon as the Tx2 (channel 1) is running then the MO mode is engaged.
+
+The MO mode triggers the doubling of the sample rate and since the sample rate is common to the DAC and ADC it is also doubled for Rx channels. If some device sets for Rx channels are present then the sample rate in these device sets is automatically adjusted.
+
+For example the channel 0 is started alone at a sample rate of 3 MS/s and a sibling Rx channel is also handled in another device set. Then the sample rate of this Rx channel is also 3 MS/s. If the second Tx channel is started then the sample rate is doubled to 6 MS/s for the Tx channels and also for the Rx channel. If the second Tx channel is stopped then a transistion from MO to SO (Single Output) occurs and the sample rate is returned to 3 MS/s for all Tx and Rx channels present. 
+
+<h2>Interface</h2>
+
+![BladeRF2 output plugin GUI](../../../doc/img/BladeRF2Output_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 occurred. In the case the device was accidentally disconnected you may click on the icon, plug back in 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 BladeRF device. Thus this is the device sample rate (6) divided by the interpolation factor (4).
+
+Transmission latency depends essentially in the delay in the sample FIFO. The FIFO size is calculated as follows:
+
+For interpolation by 32 the size is fixed at 150000 samples, Delay is 150000 / B where B is the baseband sample rate. Below is the delay in seconds vs baseband sample rate in kS/s from 48 to 500 kS/s:
+
+![BladeRF1 output plugin FIFO delay 32](../../../doc/img/BladeRF1Output_plugin_fifodly_32.png)
+
+For lower interpolation rates the size is calculated to give a fixed delay of 250 ms or 75000 samples whichever is bigger. Below is the delay in seconds vs baseband sample rate in kS/s from 48 to 400 kS/s. The 250 ms delay is reached at 300 kS/s:
+
+![BladeRF1 output plugin FIFO delay other](../../../doc/img/BladeRF1Output_plugin_fifodly_other.png) 
+  
+<h3>3: Frequency</h3>
+
+This is the center frequency of transmission in kHz. The center frequency is the same for all Tx channels. The GUI of the sibling channel if present is adjusted automatically.
+
+<h3>4: LO ppm correction</h3>
+
+Use this slider to adjust LO correction in ppm. It can be varied from -20.0 to 20.0 in 0.1 steps and is applied in software. This applies to the oscillator that controls both the Rx and Tx frequency therefore it is also changed on the related Rx and Tx plugin(s) if they are active.
+
+<h3>5: Tx filter bandwidth</h3>
+
+This is the Tx filter bandwidth in kHz. Minimum and maximum values are adjusted automatically. Normal range is from 200 kHz to 56 MHz. The Tx filter bandwidth is the same for all Tx channels. The GUI of the sibling channel if present is adjusted automatically.
+
+<h3>6: Transverter mode open dialog</h3>
+
+This button opens a dialog to set the transverter mode frequency translation options:
+
+![SDR Daemon source input stream transverter dialog](../../../doc/img/RTLSDR_plugin_xvrt.png)
+
+Note that if you mouse over the button a tooltip appears that displays the translating frequency and if translation is enabled or disabled. When the frequency translation is enabled the button is lit.
+
+<h4>6.1: Translating frequency</h4>
+
+You can set the translating frequency in Hz with this dial. 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. Wheels are moved with the mousewheel while pointing at the wheel or by selecting the wheel with the left mouse click and using the keyboard arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
+
+The frequency set in the device is the frequency on the main dial (1) minus this frequency. Thus it is positive for up converters and negative for down converters. 
+
+For example with a mixer at 120 MHz for HF operation you would set the value to -120,000,000 Hz so that if the main dial frequency is set to 7,130 kHz the PlutoSDR will be set to 127.130 MHz.
+
+If you use an up converter to transmit at the 6 cm band narrowband center frequency of 5670 MHz with the PlutoSDR set at 432 MHz you would set the translating frequency to 5760 - 432 = 5328 MHz thus dial +5,328,000,000 Hz.
+
+For bands even higher in the frequency spectrum the GHz digits are not really significant so you can have them set at 1 GHz. Thus to transmit at the 10368 MHz frequency with 432 MHz for the PlutoSDR you would set the translating frequency to 1368 - 432 = 936 MHz. Note that in this case the frequency of the LO used in the mixer of the transverter is set at 9936 MHz.
+
+The Hz precision allows a fine tuning of the transverter LO offset
+
+<h4>6.2: Translating frequency enable/disable</h4>
+
+Use this toggle button to activate or deactivate the frequency translation
+
+<h4>6.3: Confirmation buttons</h4>
+
+Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes. 
+
+<h3>7: Device sample rate</h3>
+
+This is the BladeRF device DAC 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. Wheels are moved with the mousewheel while pointing at the wheel or by selecting the wheel with the left mouse click and using the keyboard arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
+
+<h3>8: Interpolation factor</h3>
+
+The baseband stream is interpolated by this value before being sent to the BladeRF device. Possible values are:
+
+  - **1**: no interpolation
+  - **2**: multiply baseband stream sample rate by 2
+  - **4**: multiply baseband stream sample rate by 4
+  - **8**: multiply baseband stream sample rate by 8
+  - **16**: multiply baseband stream sample rate by 16
+  - **32**: multiply baseband stream sample rate by 32
+
+The main samples buffer is based on the baseband sample rate and will introduce ~500ms delay for interpolation by 16 or lower and ~1s for interpolation by 32. 
+
+<h3>9: Gain control</h3>
+
+Use this slider to adjust gain in manual mode. The gain varies from -89 to 0 dB in 1 dB steps. Thus this is in fact an attenuator
+
+<h3>10: Bias tee control</h3>
+
+Use this toggle button to activate or de-activate the bias tee. Note that according to BladeRF v2 specs the bias tee is simultanously present on all Tx RF ports. The GUI of the sibling channel if present is adjusted automatically.

plugins/samplesource/bladerf2input/readme.md

@@ -2,7 +2,7 @@
 
 <h2>Introduction</h2>
 
-This input sample source plugin gets its samples from a [BladeRF 2.0 micro device](https://www.nuand.com/bladerf-2) using LibbladeRF v.2. This is available since v4.2.0 in Linux distributions only.
+This input sample source plugin gets its samples from a [BladeRF 2.0 micro device](https://www.nuand.com/bladerf-2) using LibbladeRF v.2.
 
 <h2>Build</h2>
 
@@ -40,22 +40,52 @@ Record baseband I/Q stream toggle button
 
 Baseband I/Q sample rate in kS/s. This is the device sample rate (4) divided by the decimation factor (6). 
 
-<h3>2: Auto correction options</h3>
+<h3>2: LO ppm correction</h3>
+
+Use this slider to adjust LO correction in ppm. It can be varied from -20.0 to 20.0 in 0.1 steps and is applied in software. This applies to the oscillator that controls both the Rx and Tx frequency therefore it is also changed on the related Rx and Tx plugin(s) if they are active.
+
+<h3>3: Auto correction options</h3>
 
 These buttons control the local DSP auto correction options:
 
   - **DC**: auto remove DC component
   - **IQ**: auto make I/Q balance. The DC correction must be enabled for this to be effective.
   
-<h3>3: Rx filter bandwidth</h3>
+<h3>4: Rx filter bandwidth</h3>
 
 This is the Rx filter bandwidth in kHz. Minimum and maximum values are adjusted automatically. Normal range is from 200 kHz to 56 MHz. The Rx filter bandwidth is the same for all Rx channels. The GUI of the sibling channel if present is adjusted automatically.
 
-<h3>4: Bias tee control</h3>
+<h3>5: Transverter mode open dialog</h3>
 
-Use this toggle button to activate or de-activate the bias tee. Note that according to BladeRF v2 specs the bias tee is simultanously present on all Rx RF ports. The GUI of the sibling channel if present is adjusted automatically.
+This button opens a dialog to set the transverter mode frequency translation options:
 
-<h3>5: Device sample rate</h3>
+![Input stream transverter dialog](../../../doc/img/RTLSDR_plugin_xvrt.png)
+
+Note that if you mouse over the button a tooltip appears that displays the translating frequency and if translation is enabled or disabled. When the frequency translation is enabled the button is lit.
+
+<h4>5.1: Translating frequency</h4>
+
+You can set the translating frequency in Hz with this dial. 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. Wheels are moved with the mousewheel while pointing at the wheel or by selecting the wheel with the left mouse click and using the keyboard arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
+
+The frequency set in the device is the frequency on the main dial (1) minus this frequency. Thus it is positive for down converters and negative for up converters. 
+
+For example a mixer at 120 MHz for HF operation you would set the value to -120,000,000 Hz so that if the main dial frequency is set at 7,130 kHz the PlutoSDR will be set to 127.130 MHz.
+
+If you use a down converter to receive the 6 cm band narrowband center frequency of 5670 MHz at 432 MHz you would set the translating frequency to 5760 - 432 = 5328 MHz thus dial +5,328,000,000 Hz.
+
+For bands even higher in the frequency spectrum the GHz digits are not really significant so you can have them set at 1 GHz. Thus to receive the 10368 MHz frequency at 432 MHz you would set the translating frequency to 1368 - 432 = 936 MHz. Note that in this case the frequency of the LO used in the mixer of the transverter is set at 9936 MHz.
+
+The Hz precision allows a fine tuning of the transverter LO offset
+
+<h4>5.2: Translating frequency enable/disable</h4>
+
+Use this toggle button to activate or deactivate the frequency translation
+
+<h4>5.3: Confirmation buttons</h4>
+
+Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes. 
+
+<h3>6: Device sample rate</h3>
 
 This is the BladeRF device ADC sample rate in S/s.
 
@@ -63,7 +93,7 @@ Use the wheels to adjust the sample rate. Left click on a digit sets the cursor
 
 The ADC sample rate is the same for all Rx channels. The GUI of the sibling channel if present is adjusted automatically.
 
-<h3>6: Baseband center frequency position relative the the BladeRF Rx center frequency</h3>
+<h3>7: Baseband center frequency position relative the the BladeRF Rx center frequency</h3>
 
 Possible values are:
 
@@ -76,11 +106,11 @@ With SR as the sample rate before decimation Fc is calculated as:
   - if decimation n is 4 or lower:  Fc = SR/2^(log2(n)-1). The device center frequency is on the side of the baseband. You need a RF filter bandwidth at least twice the baseband.
   - if decimation n is 8 or higher: Fc = SR/n. The device center frequency is half the baseband away from the side of the baseband. You need a RF filter bandwidth at least 3 times the baseband.
 
-<h3>7: Decimation factor</h3>
+<h3>8: Decimation factor</h3>
 
 The I/Q stream from the BladeRF ADC is downsampled by a power of two before being sent to the passband. Possible values are increasing powers of two: 1 (no decimation), 2, 4, 8, 16, 32, 64.
 
-<h3>8: Gain mode</h2>
+<h3>9: Gain mode</h2>
 
 This selects the gain processing in use. Values are fetched automatically from the device. Normal values are
 
@@ -90,6 +120,11 @@ This selects the gain processing in use. Values are fetched automatically from t
   - **slow**: slow AGC
   - **hybrid**: hybrid AGC
 
-<h3>9: Manual gain control</h3>
+<h3>10: Manual gain control</h3>
 
 Use this slider to adjust gain in manual mode. This control is disabled in non manual modes (all modes but manual). The minumum, maximum and step values are fetched automatically from the device and may vary depending on the center frequency. For frequencies around 400 MHz the gain varies from -16 to 60 dB in 1 dB steps.
+
+<h3>11: Bias tee control</h3>
+
+Use this toggle button to activate or de-activate the bias tee. Note that according to BladeRF v2 specs the bias tee is simultanously present on all Rx RF ports. The GUI of the sibling channel if present is adjusted automatically.
+