Starting with version 2 SDRangel supports running several sampling devices simultaneously. Each concurrent device is associated to a slot with a set of tabbed windows in the UI. These tabs are marked R0, R1, R2...
The slots are arranged in a stacked fashion so that when a new device is added with the Acquisition -> Add device set menu a new slot is allocated in the last position and when a device is removed with the Acquisition -> Remove last device set menu the slot in the last position is deleted. Slot 0 (R0) receiver slot is created at initialization and cannot be deleted with the menu. The letter "R" in the tab names indicates that the slot is for a receiver (source) device while "T" designates a transmitter (sink) device.
The sampling devices tab (1) acts as a master and when one of its tabs is selected all other tabs are selected accordingly i.e. all R0s, all R1s, etc... in tabs (2), (3), (4) and (5)
In each slave tab group (2), (3), (4) and (5) an individual tab corresponding to one device can be selected without affecting the selection of the other tabs. This way you can sneak peek into another spectrum or channel group without affecting the display of other tabbed windows.
An additional dock widget supports the feature plugins. Plugins can be grouped in logical sets and graphically presented as tab groups (similarly to channels). For now there is only one "FO" group.
Details of the feature plugins dock widget are presented in section 8
- _AMBE_: Opens a dialog to select AMBE3000 serial devices or AMBE server addresses to use for AMBE digital voice processing. If none is selected AMBE frames decoding will be done with mbelib if available else no audio will be produced for AMBE digital voice (see 1.3 below for details)
- _My Position_: opens a dialog to enter your station ("My Position") coordinates in decimal degrees with north latitudes positive and east longitudes positive. This is used whenever positional data is to be displayed (APRS, DPRS, ...). For it now only works with D-Star $$CRC frames. See [DSD demod plugin](../plugins/channelrx/demoddsd/readme.md) for details on how to decode Digital Voice modes.
When clicking on the AMBE submenu a dialog opens to let you specify physical AMBE devices to decode AMBE frames produced by digital voice signals (using DSD decoder plugin).
<h5>1.3.1 AMBE server address and port or direct input</h5>
Use this freeflow text input box to specify either the address and port of an AMBE server in the form: <IPv4 address>:<port> or any directly attached physical device address like a COM port on Windows.
<h5>1.3.2 Import above address or device</h5>
Import the address or device specified in (1) into the list of used devices. The system will try to open the device or contact the server and will add it to the list only if successful.
<h5>1.3.3 Remove in use device or address</h5>
When a device or address is selected in the in use list (6) push this button to remove it from the list. The corresponding resources will be released.
<h5>1.3.4 Refresh in use list</h5>
Checks the list of devices or addresses currently in use and update the in use list (6).
<h5>1.3.5 Empty in use list</h5>
Removes all devices or addresses in use. The in use list (6) is cleared consequently. This removes all AMBE devices related resources attached to the current instance of the SDRangel program. Therefore consecutive AMBE frames decoding will be handled by the mbelib library if available or no audio will be output.
<h5>1.3.6 In use list</h5>
List of devices or addresses currently in use for AMBE frames decoding by this instance of the SDRangel program.
<h5>1.3.7 Import serial device</h5>
Imports a serial device scanned in the list of available AMBE 3000 serial devices (9) in the in use list. If this device is already in the in use list then nothing happens and this is reported in the status text (10)
<h5>1.3.8 Import all serial devices</h5>
Imports all serial devices scanned in the list of available AMBE 3000 serial devices (9) in the in use list. If any device is already in the in use list then it is not added twice.
<h5>1.3.9 List of available AMBE 3000 serial devices</h5>
This is the list of AMBE 3000 currently attached to the system directly. This list gets updated at every opening of the dialog.
<h5>1.3.10 Status text</h5>
A brief text reports the result of the current action
Only in Linux and if LimeSuite library is available this opens a dialog to control a LimeRFE device via USB. The details are provided [here](limerfeusbgui.md).
The plugin entry can be expanded or collapsed using the caret on the left. When expanded it shows more information about the copyright of the author and locations on the web where the plugin can be found. In all cases this is just here.
Use this combo box to select the device. Only available devices will appear in the list. For devices having more than one channel (ex: LimeSDR) the channel number will appear next to the device sequence number inside the brackets. Ex: `LimeSDR[0:1] 0009060B00473419` designates the second Rx (Rx #1) of the first encountered LimeSDR which serial number is 0009060B00473419.
<h5>2.1.2: Device selection confirmation</h5>
Use the `OK` button to confirm your choice and exit the dialog
<h5>2.1.3: Device selection cancellation</h5>
Use the `Cancel` button to exit the dialog without any change
<h4>2.2: Reload currently selected device</h4>
This button activates a close/open sequence to recycle the device. It may be useful when the device is not streaming anymore or in an attempt to clear possible errors. Make sure the streaming is stopped first.
<h4>2.3: Current device identfier</h4>
The identifier as shown in cotrol (2.1.1) appears truncated to the first 40 characters.
**For every device there are the following common controls:**
- When a play icon (▶) is displayed with a grey background the device is not operational
- When a play icon (▶) is displayed with a blue background the device is ready to start
- When a stop icon (■) is displayed with a green background the device is currently running
- When a play icon (▶) is displayed with a red background there is an error and a popup displays the error message. An Error typically occurs when you try to start the same device in more than one tab.
Use this checkbox to toggle on/off the reverse API feature. With reverse API engaged the changes in the device settings are forwarded to an API endpoint given by address (2.1.2.2), port (2.1.2.3) and device index (2.1.2.4) in the same format as the SDRangel REST API device settings endpoint. With the values of the screenshot the API URL is: `http://127.0.0.1:8888/sdrangel/deviceset/0/device/settings` The JSON payload follows the same format as the SDRangel REST API device settings. For example with HachRF Rx this would be something like:
Note that the PATCH method is used. The full set of parameters is sent only when the reverse API is toggled on or a full settings update is done.
The start and stop actions are also forwarded with the `/sdrangel/deviceset/{deviceSetIndex}/device/run` API endpoint using POST (start) or DELETE (stop) methods.
More details on this feature can be found on the corresponding Wiki page.
This is the sampling rate in kS/s of the I/Q stream extracted from the device after possible decimation. The main spectrum display corresponds to this sampling rate.
This is the current center frequency in kHz with dot separated thousands (MHz, GHz). On devices for which frequency can be directly controlled (i.e. all except File Source and Remote Input) you can use the thumbwheels to set the frequency. Thumbwheels move with the mouse wheel when hovering over a digit.
FFT Overlap in number of samples over half of the FFT size. The percentage of overlap appears in the tooltip. Ranges from 0 (no overlap) to half the FFT size minus one (maximum overlap).
Use this combo to select which averaging mode is applied:
- **No**: no averaging. Disables averaging regardless of the number of averaged samples (4.6). This is the default option
- **Mov**: moving average. This is a sliding average over the amount of samples specified next (4.6). There is one complete FFT line produced at every FFT sampling period
- **Fix**: fixed average. Average is done over the amount of samples specified next (4.6) and a result is produced at the end of the corresponding period then the next block of averaged samples is processed. There is one complete FFT line produced every FFT sampling period multiplied by the number of averaged samples (4.6). The time scale on the waterfall display is updated accordingly.
- **Max**: this is not an averaging but a max hold. It will retain the maximum value over the amount of samples specified next (4.6). Similarly to the fixed average a result is produced at the end of the corresponding period which results in slowing down the waterfall display. The point of this mode is to make outlying short bursts within the "averaging" period stand out. With averaging they would only cause a modest increase and could be missed out.
Each FFT bin (squared magnitude) is averaged or max'ed over a number of samples. This combo allows selecting the number of samples between these values: 1 (no averaging), 2, 5, 10, 20, 50, 100, 200, 500, 1k (1000) for all modes and in addition 2k, 5k, 10k, 20k, 50k, 1e5 (100000), 2e5, 5e5, 1M (1000000) for "fixed" and "max" modes. Averaging reduces the noise variance and can be used to better detect weak continuous signals. The fixed averaging mode allows long time monitoring on the waterfall. The max mode helps showing short bursts that may appear during the "averaging" period.
The resulting spectrum refresh period appears in the tooltip taking sample rate, FFT size (3A.2), average size (3A.5) and overlap (3A.3) into consideration. Averaging size adjustment is valid for fixed average and max modes only:
Scales spectrum by setting reference level and range automatically based on maximum and minimum levels. Takes the average of FFT size ÷ 32 minima for the minimum and 10 dB over maximum for the maximum.
The refresh rate of the spectrum is capped by this value in FPS i.e the refresh period in seconds is 1 ÷ FPS. The default value is 20 and corresponds to general usage. You may use a lower value to limit GPU usage and power consumption. You may also use a higher value for an even more reactive display. "NL" corresponds to "No Limit". With "No Limit" the spectrum update will be triggered immediately when a new FFT is calculated. Note that actual refresh rate will be limited by other factors related to hardware and graphics drivers.
The refresh period is limited anyway by the FFT period which is the FFT size divided by the baseband sampling rate and multiplied by the fixed average or max size (3A.5) in case these features are engaged (3A.4). Setting a resulting FFT refresh time above the refresh rate will make sure that a short burst is not missed particularly when using the max mode.
Use this toggle button to switch between spectrum logarithmic and linear scale display. The face of the button will change to represent either a logaritmic or linear curve.
When in linear mode the range control (4.4) has no effect because the actual range is between 0 and the reference level. The reference level in dB (4.3) still applies but is translated to a linear value e.g -40 dB is 1e-4. In linear mode the scale numbers are formatted using scientific notation so that they always occupy the same space.
A websockets based server can be used to send spectrum data to clients. An example of such client can be found in the [SDRangelSpectrum](https://github.com/f4exb/sdrangelspectrum) project.
- Left button: toggles server on/off
- Right button: opens a secondary dialog that lets you choose the server listening (local) address and port.
The server only sends data. Control including FFT details is done via the REST API. FFT frames are formatted as follows (in bytes):
<table>
<tr>
<th>Offset</th>
<th>Length</th>
<th>Value</th>
</tr>
<tr>
<td>0</td>
<td>8</td>
<td>Center frequency in Hz as 64 bit integer</td>
</tr>
<tr>
<td>8</td>
<td>8</td>
<td>Effective FFT time in milliseconds as 64 bit integer</td>
</tr>
<tr>
<td>16</td>
<td>8</td>
<td>Unix timestamp in milliseconds as 64 bit integer</td>
</tr>
<tr>
<td>24</td>
<td>4</td>
<td>FFT size as 32 bit integer</td>
</tr>
<tr>
<td>28</td>
<td>4</td>
<td>FFT bandwidth in Hz as 32 bit integer</td>
</tr>
<tr>
<td>32</td>
<td>4</td>
<td>
Indicators as 32 bit integer LSB to MSB:
<ul>
<li>bit 0: Linear (1) / log (0) spectrum indicator</li>
This resets the maximum spectrum trace and phosphor remanence
<h4>3C.2. Phosphor display</h4>
Toggles the phosphor display on the spectrum
<h4>3C.3. Phosphor display stroke and max hold decay</h4>
This controls the decay rate of the stroke when phosphor display is engaged (4.C). The histogram pixel value is diminished by this value each time a new FFT is produced. A value of zero means no decay and thus phosphor history and max hold (red line) will be kept until the clear button (4.B) is pressed.
<h4>3C.4. Phosphor display stroke and max hold decay divisor</h4>
When phosphor display is engaged (4.C) and stroke decay is 1 (4.7) this divides the unit decay by this value by diminishing histogram pixel value by one each time a number of FFTs equal to this number have been produced. Thus the actual decay rate is 1 over this value. This allow setting a slower decay rate than one unit for each new FFT.
<h4>3C.5. Phosphor display stroke strength</h4>
This controls the stroke strength when phosphor display is engaged (4.C). The histogram value is incremented by this value at each new FFT until the maximum (red) is reached.
<h4>3C.6. Maximum hold trace</h4>
Toggles the maximum hold trace display (red trace) on the spectrum
<h4>3C.7. Current trace</h4>
Toggles the current trace display (yellow trace) on the spectrum
<h4>3C.8. Trace intensity</h4>
This controls the intensity of the maximum (4.D) and current (4.E) spectrum trace
<h4>3C.9. Waterfall/spectrum placement</h4>
Toggles the spectrum on top or on bottom versus waterfall
The presets and commands tree view are by default stacked in tabs. The following sections describe the presets section 5A) and commands (section 5B) views successively
This is a tree view of the saved presets. Presets record the channels setup and a copy of the settings of each sample source that has been used when saving this preset. Thus you can use the same channel arrangement with various devices having their particular setup.
Click on this icon to create a update the selected preset with the current values in the selected sample device tab (Main window: 2). Please note that this does not save the preset immediately on disk to save presets immediately you need to use the save button (4).
Using the previous icon presets are saved globally in a system dependent place. Using this icon you can export a specific preset in a single file that can be imported on another machine possibly with a different O/S. The preset binary data (BLOB) is saved in Base-64 format.
This is a tree view of the saved commands. Commands describe the path to an executable file, its arguments a possible link to a keystroke event that triggers the execution. Similarly to presets commands can be arranged into groups and have a description short text.
Typically an "executable file" is a script (Python, shell, whatever...) or can be a compiled program (c, c++, java, whatever...) that interacts with SDRangel using its web REST API. When called from within SDRangel they can act as "macros" allowing to perform actions automatically.
You select a command or a command group by clicking on its line in the tree view. All actions (6) will be done relative to this command or command group.
Click on this icon to duplicate the currently selected command (inactive on groups). Later you can edit the details of the copy with the edit dialog (see 5B.6.3 next)
With this dialog you can rename a group using the text box or if you select an existing group with the combo this will merge the contents of the group with the existing group
<b>Commands</b>
You can edit the details of the command with this dialog.
Clicking on this button will open a file dialog to select the executable file that will be run with this command. The file selection dialog has predefined file pattern selections:
Use this button to capture the key or key combination that will be used for the key binding. After pushing this button just type in the key or key combination.
This will run the currently selected command. If the selection is a group it will run all commands of the group starting them in the displayed order. Please note that commands are run in independent processes and therefore all launched commands in the group will run concurrently.
This is the translation of `QProcess::ProcessError`. Possible values are:
-`...`: the process has never run during this session
-`Failed to start`: the process could not start. For example the executable file has no execution rights actually
-`Crashed`: the process ended with crash. This is the status when you killed the process
-`Timed out`: the last waitFor...() function timed out.
-`Write error`: an error occurred when attempting to write to the process. For example, the process may not be running, or it may have closed its input channel.
-`Read error`: an error occurred when attempting to read from the process. For example, the process may not be running.
This is the program exit code. When the process crashes this is the signal by which the process end was caused. For example if you kill the process with button (6) it sends the process a SIGKILL (code 9) and therefore the value is 9.
Use this button to activate the keyboard bindings. Note that you need to have this button selected (its background should be lit in beige/orange) for the key bindings to be effective.
This area shows the control GUIs of the channels currently active for the device. When the preset is saved (as default at exit time or as a saved preset) the GUIs are ordered by increasing frequency. If presets share the same frequency they are ordered by their internal ID name. Thus new channel GUIs will appear ordered only when reloaded.
Details about the GUIs can be found in the channel plugins documentation which consists of a readme.md file in each of the channel plugins folder (done partially).
Use this combo to select which channel type to add
<h5>5.1.2: Close dialog</h5>
Use this button to dismiss the dialog
<h5>5.1.3: Add channel</h5>
Add a new channel by clicking on the `Apply` button. You may click it several times to add more channels. The dialog can be dismissed with the `Close` button or the closing window icon `X` on the top bar.
With most channel types some common basic settings can be set with a popup dialog. This dialog is opened by clicking on the small grey square on the top left of the channel window. The settings are as follows:
Changes the color of the window title bar and spectrum overlay. To change the color click on the color square to open a color chooser dialog. The hex rgb value is displayed next to the color square.
When the mouse is over the channel window or over the central line in the spectrum a channel parameter is displayed on the frequency scale. This parameter can be:
Use this checkbox to toggle on/off the reverse API feature. With reverse API engaged the changes in the channel settings are forwarded to an API endpoint given by address (5.1.5), port (5.1.6), device index (5.1.7) and channel index (5.1.8) in the same format as the SDRangel REST API channel settings endpoint. With the values of the screenshot the API URL is: `http://127.0.0.1:8888/sdrangel/deviceset/0/channel/0/settings` The JSON payload follows the same format as the SDRangel REST API channel settings. Using the same example this would be:
The bigger square next to the leftmost "c" square is the device stream assignment control. With single Rx (source device set) and single Tx devices (sink device set) this is inactive because the channel is simply connected to the single stream as shown by the "S" letter.
This is in place for future MIMO devices and channels support (v.5).
This shows the spectrum in the passband returned from the sampling device possibly after decimation. The actual sample rate is shown in the device control at the left of the frequency display (2.3)
Use Shift and mouse left click to set a new marker. There is a maximum of two markers with a different status:
- The first marker will display frequency (2) and power (1) or time (5) on the scale side of the view. Frequency units are the same as displayed in the frequency scale.
- The second marker will display frequency difference (3 or 6) and power difference (4) or time difference (7) from the first marker on the opposite side of the scales. Difference values may be suffixed with a multiplier character.
Base units are Hz for frequency difference and seconds for time. Power is expressed either in dB or plain value depending on the linear or log setting for the spectrum display.
Use mouse right click anywhere in the view to remove the last entered marker. Use shift and mouse right click to remove all markers.
Any change in the spectrum settings is not reflected in the markers. You have to clear them and make a new measurement if any critical setting of the spectrum is changed.
When the mouse is in the spectrum or waterfall area but not over the center line of a channel it will zoom in/out along X (frequency) axis by a 0.5 step at each scroll up/down respectively between 1x (no zoom) and 10x. Note that in order to zoom on the center line of a channel you may move the mouse pointer in the top margin (center line moving is not active there but zooming is).
When the mouse is inside the power scale (spectrum) the power range is decreased by 2 (zoom in) or increased by 2 (zoom in) at each wheel step forward or backward respectively. The behavior of the reference level depends on where in the scale is the mouse pointer:
- in the top third: the reference level is maintained thus the reference level at the top stays the same
- in the middle third: the reference level is decreased by 1 (zoom in) or increased by 1 (zoom out) at each wheel step forward or backward thus the level in the middle stays the same
- in the bottom third: the reference level is decreased by 2 (zoom in) or increased by 2 (zoom out) at each wheel step forward or backward thus the level at the bottom stays the same
When the mouse is inside the time scale (waterfall) the overlap is increased by 1 (zoom in) or decreased by 1 (zoom out) at each wheel step forward or backward respectively. Overlap is bounded by 0 and half of the FFT size minus one.
This is the current tag or the latest tag followed by the number of commits since the latest tag followed by the git commit SHA1 (8 hex characters) preceded by 'g'. Ex: `v4.5.3-29-gf5f2349d`
Feature plugins implement pieces of functionality not directly related to the I/Q stream(s) DSP processing and not part of the core functionality. It can control and interact devices and channels to achieve this specialzed piece of functionality. Examples are PTT (Push To Talk) to switchover Rx/Tx device sets as you would do with a transciever or control via rigctl protocol.
This area shows the feature GUIs of the features currently instantiated (active). The top bar has the following controls:
<h4>8.1 Add feature</h4>
Click on this button to open a dialog to add features. The dialog function is similarl to the add channels dialog in section 5.1:
Use this combo to select which feature type to add
<h5>8.1.2: Close dialog</h5>
Use this button to dismiss the dialog
<h5>8.1.3: Add feature</h5>
Add a new feature by clicking on the `Apply` button. You may click it several times to add more feature instances. The dialog can be dismissed with the `Close` button or the closing window icon `X` on the top bar.
<h4>8.2: Basic features settings</h4>
At the left of the top bar of every feature GUI a "c" button opens a dialog to set some parameters common to all feature plugins:
Changes the color of the window title bar. To change the color click on the color square to open a color chooser dialog. The hex rgb value is displayed next to the color square.
<h5>8.2.3: Toggle reverse API feature</h5>
Use this checkbox to toggle on/off the reverse API feature. With reverse API engaged the changes in the feature settings are forwarded to an API endpoint given by address (8.2.4), port (8.2.5), feature set index (8.2.6) and feature index (8.2.7) in the same format as the SDRangel REST API feature settings endpoint. With the values of the screenshot the API URL is: `http://127.0.0.1:8888/sdrangel/featureeset/0/feature/0/settings` The JSON payload follows the same format as the SDRangel REST API feature settings. Using the same example this would be:
```
{
"SimplePTTSettings": {
"reverseAPIAddress": "127.0.0.1",
"reverseAPIChannelIndex": 0,
"reverseAPIDeviceIndex": 0,
"reverseAPIPort": 8888,
"rgbColor": -65536,
"rx2TxDelayMs": 200,
"rxDeviceSetIndex": 0,
"title": "Simple PTT",
"tx2RxDelayMs": 200,
"txDeviceSetIndex": 1,
"useReverseAPI": 0
},
"featureType": "SimplePTT"
}
```
Note that the PATCH method is used. The full set of parameters is sent with the PUT method only when the reverse API is toggled on or a full settings update is done.
<h5>8.2.4: API address</h5>
This is the IP address of the API endpoint
<h5>8.2.5: API port</h5>
This is the IP port of the API endpoint
<h5>8.2.6: Feature set index</h5>
This is the targeted feature set index
<h5>8.2.7: Feature index</h5>
This is the targeted feature index
<h5>8.2.8: Cancel changes and exit dialog</h5>
Do not make any changes and exit dialog
<h5>8.2.9: Validate and exit dialog</h5>
Validates the data and exits the dialog
<h4>8.3: Presets dialog</h4>
Feature sets (groups) can be saved to and retrieved from specialized feature presets
Move the cursor to select a feature. Features can be organized into groups at the top level (here "Test"). When selecting a group only Edit and Delete group are available
<h5>8.3.2: Add new preset</h5>
Save the current feature set in a new preset.
<h5>8.3.3: Update selected preset</h5>
Update the selected preset with the current feature set
<h5>8.3.4: Save presets</h5>
This button is inactive. All presets are saved at program exit or with the Presets save button.
<h5>8.3.5: Edit preset</h5>
Change preset name or the preset group to which this preset belongs. If selection is a group the group name can be changed.
<h5>8.3.6: Delete preset</h5>
Delete selected preset or selected group
<h5>8.3.7: Load preset</h5>
Load preset in the current feature set. The Features that were present before are dismissed.
