PlutoSDR: updated documentation

plugins/samplesink/limesdroutput/readme.md

@@ -158,7 +158,7 @@ Use this toggle button to switch the sample rate input next (10) between host to
 
 This is the LMS7002M device to/from host stream sample rate or baseband sample rate in samples per second (S/s). The control (10A) is used to switch between the two input modes. The device to/from host stream sample rate is the same for the Rx and Tx systems.
 
-The limits are adjusted automatically. In baseband input mode the limits are driven by the interpolation factor (9). You may need to increase this interpolation factor to be able to reach lower values.
+The limits are adjusted automatically. In baseband input mode the limits are driven by the software interpolation factor (9). You may need to increase this interpolation factor to be able to reach lower values.
 
 This is the LMS7002M device to/from host stream sample rate in S/s. It is the same for the Rx and Tx systems.
 

plugins/samplesink/plutosdroutput/readme.md

@@ -20,7 +20,7 @@ The plugin will be built only if libiio is installed in your system. To build an
   - `cmake -DCMAKE_INSTALL_PREFIX=/opt/install/libiio -DINSTALL_UDEV_RULE=OFF ..`
   - `make -j8`
   - `make install`
-  
+
 Then add the following defines on `cmake` command line when compiling SDRangel:
 
 `-DIIO_DIR=/opt/install/libiio`
@@ -41,19 +41,21 @@ AD9363 extended frequency range is not guaranteed but would work normally partic
 
 <h4>1.2: Start/Stop</h4>
 
-Device start / stop button. 
+Device start / stop button.
 
   - Blue triangle icon: device is ready and can be started
   - Green 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 to stop, plug back in, check the source on the sampling devices control panel and start again.
-  
+
 <h4>1.3: DAC sample rate</h4>
 
 This is the sample rate at which the DAC runs in kS/s (k) or MS/s (M) after hardware interpolation. Hardware interpolation is only partially controlled by the user using the FIR interpolation factor (9). The value here is the value returned by the device interface therefore it is always exact.
 
-<h4>1.4: Stream sample rate</h4>
+<h3>1.4: Stream sample rate</h3>
 
-Baseband I/Q sample rate in kS/s. This is the host to device sample rate (5) divided by the software interpolation factor (3). 
+In host to device sample rate input mode (5A) this is the baseband I/Q sample rate in kS/s. This is the host to device sample rate (5) divided by the software interpolation factor (3).
+
+In baseband sample rate input mode (5A) this is the host to device sample rate in kS/s. This is the baseband sample rate (5) multiplied by the software interpolation factor (3)
 
 <h3>2: LO ppm correction</h3>
 
@@ -71,7 +73,7 @@ Note that if you mouse over the button a tooltip appears that displays the trans
 
 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. 
+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.
 
@@ -87,7 +89,7 @@ Use this toggle button to activate or deactivate the frequency translation
 
 <h4>2a.3: Confirmation buttons</h4>
 
-Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes. 
+Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes.
 
 <h3>3: Software interpolation factor</h3>
 
@@ -97,9 +99,18 @@ The I/Q stream to the PlutoSDR is upsampled by a power of two by software inside
 
 The AD9363 has many port options however as only the A output is connected you should leave it as the default. This is a provision for people who want to hack the board. The different values may be found in the AD9363 documentation.
 
-<h3>5: Host to device stream sample rate</h3>
+<h3>5A: Host to device sample rate / Baseband sample rate input toggle</h3>
 
-This is the AD9363 device to/from host stream sample rate in S/s. It is the same for the Rx and Tx systems.
+Use this toggle button to switch the sample rate input next (5) between host to device sample rate and baseband sample rate input. The button shows the current mode:
+
+  - **SR**: host to device sample rate input mode. The baseband sample rate (1.4) is the host to device sample rate (5) divided by the software interpolation factor (3).
+  - **BB**: baseband sample rate input mode. The host to device sample rate (1.4) is the baseband sample rate (5) multiplied by the software interpolation factor (3).
+
+<h3>5: Sample rate</h3>
+
+This is the device to/from host stream sample rate or baseband sample rate in samples per second (S/s). The control (5A) is used to switch between the two input modes. The device to/from host stream sample rate is the same for the Rx and Tx systems.
+
+The limits are adjusted automatically. In baseband input mode the limits are driven by the software interpolation factor (3). You may need to increase this interpolation factor to be able to reach lower values.
 
 Use the wheels to adjust the sample rate. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2. 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.
 
@@ -108,7 +119,7 @@ The minimum sample rate depends on the hardware FIR decimation factor (9) and is
   - no decimation: 25/12 MS/s thus 2083336 S/s (next multiple of 4)
   - decimation by 2: 25/24 MS/s thus 1041668 S/s
   - decimation by 4: 25/48 MS/s thus 520834 S/s
-  
+
 The maximum sample rate is fixed and set to 20 MS/s
 
 <h3>6: Tx analog filter bandwidth</h3>
@@ -145,7 +156,7 @@ Use this button to adjust the attenuation. It can be varied from -89.75 to 0 dB
 
 <h4>12: Indicative RSSI</h4>
 
-This is the indicative RSSI of the transmitter. It works only when the Rx is in monitor mode set with the control (7) of the input plugin. 
+This is the indicative RSSI of the transmitter. It works only when the Rx is in monitor mode set with the control (7) of the input plugin.
 
 <h3>13: Board temperature</h3>
 

plugins/samplesource/plutosdrinput/readme.md

@@ -20,7 +20,7 @@ The plugin will be built only if libiio is installed in your system. To build an
   - `cmake -DCMAKE_INSTALL_PREFIX=/opt/install/libiio -DINSTALL_UDEV_RULE=OFF ..`
   - `make -j8`
   - `make install`
-  
+
 Then add the following defines on `cmake` command line when compiling SDRangel:
 
 `-DIIO_DIR=/opt/install/libiio`
@@ -41,12 +41,12 @@ AD9363 extended frequency range is not guaranteed but would work normally partic
 
 <h4>1.2: Start/Stop</h4>
 
-Device start / stop button. 
+Device start / stop button.
 
   - Blue triangle icon: device is ready and can be started
   - Green 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 to stop, plug back in, check the source on the sampling devices control panel and start again.
-  
+
 <h4>1.3: Record</h4>
 
 Record baseband I/Q stream toggle button
@@ -57,7 +57,9 @@ This is the sample rate at which the ADC runs in kS/s (k) or MS/s (M) before har
 
 <h4>1.5: Stream sample rate</h4>
 
-Baseband I/Q sample rate in kS/s. This is the device to host sample rate (8) divided by the software decimation factor (5). 
+In device to host sample rate input mode (8A) this is the baseband I/Q sample rate in kS/s. This is the device to host sample rate (8) divided by the software decimation factor (5).
+
+In baseband sample rate input mode (8A) this is the device to host sample rate in kS/s. This is the baseband sample rate (8) multiplied by the software decimation factor (5)
 
 <h3>2: LO ppm correction</h3>
 
@@ -71,7 +73,7 @@ These buttons control the software DSP auto correction options:
   - **IQ**: (7) auto make I/Q balance. The DC correction must be enabled for this to be effective.
 
 &#9758; AD9363 has a good hardware DC and I/Q compensation so there should not be a use for this software auto-correction.
-  
+
 <h3>4a: Transverter mode open dialog</h3>
 
 This button opens a dialog to set the transverter mode frequency translation options:
@@ -84,7 +86,7 @@ Note that if you mouse over the button a tooltip appears that displays the trans
 
 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. 
+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.
 
@@ -100,7 +102,7 @@ Use this toggle button to activate or deactivate the frequency translation
 
 <h4>4a.3: Confirmation buttons</h4>
 
-Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes. 
+Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes.
 
 <h3>5: Software decimation factor</h3>
 
@@ -109,21 +111,30 @@ The I/Q stream from the PlutoSDR is downsampled by a power of two by software in
 <h3>6: Decimated bandpass center frequency position relative the the PlutoSDR Rx center frequency</h3>
 
   - **Cen**: the decimation operation takes place around the PlutoSDR Rx center frequency Fs
-  - **Inf**: the decimation operation takes place around Fs - Fc. 
+  - **Inf**: the decimation operation takes place around Fs - Fc.
   - **Sup**: the decimation operation takes place around Fs + Fc.
-  
-With SR as the sample rate before decimation Fc is calculated as: 
+
+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: Antenna (input) connection</h3>
 
 The AD9363 has many port options however as only the A balanced input is connected you should leave it as the default. This is a provision for people who want to hack the board. The different values may be found in the AD9363 documentation.
 
-<h3>8: Device to host stream sample rate</h3>
+<h3>8A: Device to host sample rate / Baseband sample rate input toggle</h3>
 
-This is the AD9363 device to/from host stream sample rate in S/s. It is the same for the Rx and Tx systems.
+Use this toggle button to switch the sample rate input next (8) between device to host sample rate and baseband sample rate input. The button shows the current mode:
+
+  - **SR**: device sample rate input mode. The baseband sample rate (1.5) is the device to host sample rate (8) divided by the software decimation factor (5).
+  - **BB**: baseband sample rate input mode. The device sample rate (1.5) is the baseband sample rate (8) multiplied by the software decimation factor (5).
+
+<h3>6: Sample rate</h3>
+
+This is the device to host sample rate or baseband sample rate in samples per second (S/s). The control (8A) is used to switch between the two input modes.
+
+The limits are adjusted automatically. In baseband input mode the limits are driven by the software decimation factor (5). You may need to increase this decimation factor to be able to reach lower values.
 
 Use the wheels to adjust the sample rate. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2. 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.
 
@@ -132,7 +143,7 @@ The minimum sample rate depends on the hardware FIR decimation factor (12) and i
   - no decimation: 25/12 MS/s thus 2083336 S/s (next multiple of 4)
   - decimation by 2: 25/24 MS/s thus 1041668 S/s
   - decimation by 4: 25/48 MS/s thus 520834 S/s
-  
+
 The maximum sample rate is fixed and set to 20 MS/s
 
 <h3>9: Rx analog filter bandwidth</h3>
@@ -169,9 +180,9 @@ Use this combo to select between gain options:
 
   - **Man**: manual: the overall gain in dB can be set with the gain button (15)
   - **Slow**: slow AGC: gain button (15) is disabled
-  - **Fast**: fast AGC: gain button (15) is disabled 
+  - **Fast**: fast AGC: gain button (15) is disabled
   - **Hybr**: hybrid AGC: gain button (15) is disabled
-  
+
 See AD9363 documentation for details on AGC options.
 
 <h4>15: Global manual gain</h4>