1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2026-06-07 16:34:45 -04:00

SoapySDR support: output: documentation

This commit is contained in:
f4exb
2018-11-22 08:52:15 +01:00
parent fb92612f60
commit e36bd24330
5 changed files with 214 additions and 2 deletions
+14 -2
View File
@@ -6,6 +6,18 @@ This input sample source plugin gets its samples from a device interfaced with [
SoapySDR is a [C/C++ API](https://github.com/pothosware/SoapySDR/blob/master/include/SoapySDR/Device.hpp) that interfaces SDR hardware on one side and application software on the other. Due to its very generic nature it was fairly difficult to implement and specific UI widgets were developped to handle specific types of parameters. The level of control depends on how the device API was implemented by the vendors. On application side some parts of the API have not been implemented and can be left as possible enhancements (see next). In any case it is recommended to use the native plugins if they are available.
SoapySDR devices appear in the list of available devices in the order they are listed in the API call to SoapySDR. If more than one device controlled by SoapySDR is listed then its sequence number is incremented like:
- SoapySDR[0:0] Generic RTL...
- SoapySDR[1:0] Generic RTL...
If the same device exposes several channels they appear as distinct devices with the channel number incremented like:
- SoapySDR[1:0] LimeSDR...
- SoapySDR[1:1] LimeSDR...
This works similarly to LimeSDR USB or BladeRF 2.0 micro
<h2>Binary distributions</h2>
The binary distributions provide only the SoapySDR base library. It is your responsibility to install SoapySDR in your system with the SoapySDR plugins suitable for your hardware.
@@ -63,7 +75,7 @@ The top part described by number tags is common for all devices. The bottom part
<h4>1.1: Frequency</h4>
This is the center frequency of reception in kHz. The center frequency is the same for all Rx channels. The GUI of the sibling channel if present is adjusted automatically. This control corresponds to the first SoapySDR tuning element usually labeled as "RF" and would generally control the main local oscillator (LO).
This is the center frequency of reception in kHz. The center frequency is usually the same for all Rx channels. The GUI of the sibling channel if present is adjusted automatically if necessary. This control corresponds to the first SoapySDR tuning element usually labeled as "RF" and would generally control the main local oscillator (LO).
Use the wheels to adjust the value. 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.
@@ -188,7 +200,7 @@ A checkbox is used to control boolean values:
![SoapySDR input plugin GUI](../../../doc/img/SoapySDR_arg_bool2.png)
For AGC, Auto DC and Auto IQ corrections a block with the text on the rihgt:
For AGC, Auto DC and Auto IQ corrections the checkbox has its text label on the right:
![SoapySDR input plugin GUI](../../../doc/img/SoapySDR_arg_bool1.png)