VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-12-23 01:55:48 -05:00
Code Issues Projects Releases Wiki Activity

LimeSDR: updated documentation

Browse Source
This commit is contained in:
f4exb 2019-04-09 23:19:52 +02:00
parent 8ab8fc3e0d
commit 7b7598b806
7 changed files with 57 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/img/LimeSDRInput_plugin.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 35 KiB

BIN
doc/img/LimeSDRInput_plugin.xcf
View File

Binary file not shown.

BIN
doc/img/LimeSDROutput_plugin.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 36 KiB

BIN
doc/img/LimeSDROutput_plugin.xcf
View File

Binary file not shown.

2
plugins/samplesink/limesdroutput/limesdroutputplugin.cpp
View File

@ -34,7 +34,7 @@
const PluginDescriptor LimeSDROutputPlugin::m_pluginDescriptor = {
QString("LimeSDR Output"),
QString("4.5.2"),
QString("4.5.4"),
QString("(c) Edouard Griffiths, F4EXB"),
QString("https://github.com/f4exb/sdrangel"),
true,

13
plugins/samplesink/limesdroutput/readme.md
View File

@ -49,9 +49,11 @@ This is the sample rate at which the DAC runs in kS/s (k) or MS/s (M) after hard
☞ Note that changing the hardware interpolation factor (8) or the host to device sample rate (10) may change the ADC clock sample rate and therefore the Rx side hardware decimation factor and/or device to host sample rate. In fact ADC and DAC sample rates can be equal or related by a factor of 2.
<h3>2B: Baseband sample rate</h3>
<h3>2B: Stream sample rate</h3>
This is the baseband sample rate in kS/s before interpolation (9) to produce the final stream that is sent to the LimeSDR device. Thus this is the host to device sample rate (10) divided by the software interpolation factor (9).
In host to device sample rate input mode (10A) this is the baseband I/Q sample rate in kS/s. This is the host to device sample rate (10) divided by the software interpolation factor (9).
In baseband sample rate input mode (10A) this is the host to device sample rate in kS/s. This is the baseband sample rate (10) multiplied by the software interpolation factor (9)
Transmission latency depends essentially in the delay in the sample FIFO. The size of sample FIFO is calculated to give a fixed delay of 250 ms or 48000 samples whichever is bigger. Below is the delay in seconds vs baseband sample rate in kS/s from 48 to 250 kS/s. The 250 ms delay is reached at 192 kS/s:
@ -145,6 +147,13 @@ Thus the actual sample rate of the DAC is the stream sample rate (10) multiplied
The I/Q stream from the baseband is upsampled by a power of two by software inside the plugin before being sent to the LimeSDR device. Possible values are increasing powers of two: 1 (no interpolation), 2, 4, 8, 16, 32.
<h3>10A: Host to device sample rate / Baseband sample rate input toggle</h3>
Use this toggle button to switch the sample rate input next (10) 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 (2B) is the host to device sample rate (10) divided by the software interpolation factor (9).
- **BB**: baseband sample rate input mode. The host to device sample rate (2B) is the baseband sample rate (8) multiplied by the software interpolation factor (9).
<h3>10: Host to device stream sample rate</h3>
This is the LMS7002M device to/from host stream sample rate in S/s. It is the same for the Rx and Tx systems.

61
plugins/samplesource/limesdrinput/readme.md
View File

@ -42,7 +42,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 (5) divided by the software decimation factor (4).
In device to host sample rate input mode (5) this is the baseband I/Q sample rate in kS/s. This is the device to host sample rate (6) divided by the software decimation factor (4).
In baseband sample rate input mode (5) this is the device to host sample rate in kS/s. This is the baseband sample rate (8) multiplied by the software decimation factor (4)
<h4>1.6: Channel number</h4>
@ -108,7 +110,14 @@ Thus the actual sample rate of the ADC is the stream sample rate (5) multiplied
The I/Q stream from the LimeSDR is downsampled 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>5: Device to host stream sample rate</h3>
<h3>5: Device to host sample rate / Baseband sample rate input toggle</h3>
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 to host sample rate input mode. The baseband sample rate (1.5) is the device to host sample rate (6) divided by the software decimation factor (4).
- **BB**: baseband sample rate input mode. The device to host sample rate (1.5) is the baseband sample rate (8) multiplied by the software decimation factor (4).
<h3>6: Device to host stream sample rate</h3>
This is the LMS7002M device to/from host stream sample rate in S/s. It is the same for the Rx and Tx systems.
@ -116,23 +125,23 @@ Use the wheels to adjust the sample rate. Pressing shift simultaneously moves di
The LMS7002M uses the same clock for both the ADCs and DACs therefore this sample rate affects all of the 2x2 MIMO channels.
<h3>6: Filters and transverter mode</h3>
<h3>7: Filters and transverter mode</h3>
![LimeSDR source filters GUI](../../../doc/img/LimeSDRInput_plugin_3.png)
<h4>6.1: Rx hardware filter bandwidth</h4>
<h4>7.1: Rx hardware filter bandwidth</h4>
This is the Rx hardware filter bandwidth in kHz in the LMS7002M device for the given channel. Boundaries are updated automatically but generally are from 1.4 to 130 MHz in 1 kHz steps. Use the wheels to adjust the value. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
<h4>6.2: TSP FIR filter toggle</h4>
<h4>7.2: TSP FIR filter toggle</h4>
The TSP in the LMS7002M chip has a FIR filter chain per channel. Use this button to activate or deactivate the TSP FIR filter.
<h4>6.3: TSP FIR filter bandwidth</h4>
<h4>7.3: TSP FIR filter bandwidth</h4>
Use the wheels to adjust the bandwidth of the hardware TSP FIR filter. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
<h4>6.4: Transverter mode open dialog</h4>
<h4>7.4: Transverter mode open dialog</h4>
This button opens a dialog to set the transverter mode frequency translation options:
@ -140,7 +149,7 @@ This button opens a dialog to set the transverter mode frequency translation opt
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.
<h5>6.4.1: Translating frequency</h5>
<h5>7.4.1: Translating frequency</h5>
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.
@ -154,41 +163,41 @@ For bands even higher in the frequency spectrum the GHz digits are not really si
The Hz precision allows a fine tuning of the transverter LO offset
<h5>6.4.2: Translating frequency enable/disable</h5>
<h5>7.4.2: Translating frequency enable/disable</h5>
Use this toggle button to activate or deactivate the frequency translation
<h5>6.4.3: Confirmation buttons</h5>
<h5>7.4.3: Confirmation buttons</h5>
Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes.
<h3>7: Gain settings</h2>
<h3>8: Gain settings</h2>
![LimeSDR input plugin gain GUI](../../../doc/img/LimeSDRInput_plugin_9.png)
<h4>7.1: Gain mode</h2>
<h4>8.1: Gain mode</h2>
Use this combo to select either the automatic gain (Aut) or the manual (Man) gain setting. Automatic gain sets the global gain using a predefined table for LNA, TIA and PGA gain blocks. This global gain is set with button 9.2. When manual gain is engaged the LNA, TIA and PGA gains can be set independently with the 9.3, 9.4 and 9.5 buttons respectively.
Please refer to [LMS7002M documentation](http://www.limemicro.com/wp-content/uploads/2015/09/LMS7002M-Data-Sheet-v2.8.0.pdf) for a precise description of LNA, TIA and PGA and their location in the Rx chain. To summarize these blocks are placed in this order from antenna to ADC.
<h4>7.2: Global automatic gain</h4>
<h4>8.2: Global automatic gain</h4>
Use this button to adjust the global gain of the LNA, TIA and PGA. LimeSuite software automatically set optimal values of the amplifiers to achieve 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 button.
<h4>7.3: LNA manual gain</h4>
<h4>8.3: LNA manual gain</h4>
Use this button to adjust the gain of tha LNA when manual gain mode is set (7.1). Gain can be set between 1 and 30 dB in 1 dB steps. However the hardware has 3 dB steps for the lower gain values so increasing or decreasing by one step does not always produce a change. The value in dB appears at the right of the button.
Use this button to adjust the gain of tha LNA when manual gain mode is set (8.1). Gain can be set between 1 and 30 dB in 1 dB steps. However the hardware has 3 dB steps for the lower gain values so increasing or decreasing by one step does not always produce a change. The value in dB appears at the right of the button.
<h4>7.4: TIA manual gain</h4>
<h4>8.4: TIA manual gain</h4>
Use this combo to select the TIA gain in dB when manual gain mode is set (7.1). Possible values are 1,2 and 3 dB.
Use this combo to select the TIA gain in dB when manual gain mode is set (8.1). Possible values are 1,2 and 3 dB.
<h4>7.5: PGA manual gain</h4>
<h4>8.5: PGA manual gain</h4>
Use this button to adjust the gain of tha PGA when manual gain mode is set (7.1). Gain can be set between 0 and 32 dB in 1 dB steps. The value in dB appears at the right of the button.
Use this button to adjust the gain of tha PGA when manual gain mode is set (8.1). Gain can be set between 0 and 32 dB in 1 dB steps. The value in dB appears at the right of the button.
<h3>8: Antenna select</h3>
<h3>9: Antenna select</h3>
Use this combo box to select the antenna input:
@ -199,28 +208,28 @@ Use this combo box to select the antenna input:
- **T1**: Selects loopback from TX #1 (experimental)
- **T1**: Selects loopback from TX #2 (experimental)
<h3>9: Stream status indicator</h3>
<h3>10: 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 (12)
<h3>10: Stream warning indicators</h3>
<h3>11: 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>11: Stream global (all Rx) throughput in MB/s</h3>
<h3>12: Stream global (all Rx) 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 Rx stream. This is due to the fact that 12 bits samples are used and although they are represented as 16 bit values only 12 bits travel on the USB link.
<h3>12: FIFO status</h3>
<h3>13: FIFO status</h3>
This is the fill percentage of the Rx FIFO in the LimeSuite interface. It should be zero most of the time.
<h3>13: Board temperature</h3>
<h3>14: Board temperature</h3>
This is the board temperature in degrees Celsius updated every ~5s. Before the first probe the display marks "00C" this is normal.
<h3>14: GPIO pins status</h3>
<h3>15: GPIO pins status</h3>
This is the hexadecimal representation of the 8 available GPIO pins of the on board LimeSDR GPIO header.