mirror of
https://github.com/f4exb/sdrangel.git
synced 2025-06-15 13:02:27 -04:00
Massive UI revamping (v7): Channel window documentation. Show device type name in index tooltip
This commit is contained in:
parent
40e34bdebd
commit
2c070f811e
BIN
doc/img/ChannelWindow.png
Normal file
BIN
doc/img/ChannelWindow.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 31 KiB |
BIN
doc/img/ChannelWindow.xcf
Normal file
BIN
doc/img/ChannelWindow.xcf
Normal file
Binary file not shown.
BIN
doc/img/ChannelWindow_bottom.png
Normal file
BIN
doc/img/ChannelWindow_bottom.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 5.4 KiB |
BIN
doc/img/ChannelWindow_bottom.xcf
Normal file
BIN
doc/img/ChannelWindow_bottom.xcf
Normal file
Binary file not shown.
BIN
doc/img/ChannelWindow_top.png
Normal file
BIN
doc/img/ChannelWindow_top.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 9.4 KiB |
BIN
doc/img/ChannelWindow_top.xcf
Normal file
BIN
doc/img/ChannelWindow_top.xcf
Normal file
Binary file not shown.
@ -8,6 +8,8 @@ This MIMO transmission only (MO) plugin can be used to drive a 2 channel MO devi
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Channel output</h3>
|
||||
|
@ -6,6 +6,8 @@ This MIMO reception only (MI) plugin can be used to study phase difference betwe
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
The interface is divided in 3 sections that will be detailed next:
|
||||
|
@ -24,6 +24,8 @@ The same waveforms can be used to trigger the scope trace
|
||||
|
||||
<h2>B. General interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
The interface is essentially divided in the following sections
|
||||
|
@ -16,6 +16,8 @@ The ADS-B plugin can send aicraft for display on the [Map Feature](../../feature
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception value</h3>
|
||||
|
@ -16,6 +16,8 @@ The AIS specification is ITU-R M.1371-5: https://www.itu.int/dms_pubrec/itu-r/re
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to listen to a narrowband amplitude modulated signal. "N
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -18,6 +18,8 @@ The status of the NOAA POES satellites is available at: https://www.ospo.noaa.go
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
@ -69,7 +71,7 @@ This includes:
|
||||
- Whether to automatically save images on LOS.
|
||||
- Whether a combined image including telemetry should be saved.
|
||||
- Whether separate images of channel A and B, without telemetry, should be saved.
|
||||
- Whether equidistant cylindrical (plate carrée) project images used for the map, should be saved.
|
||||
- Whether equidistant cylindrical (plate carr<EFBFBD>e) project images used for the map, should be saved.
|
||||
- Path to save automatically saved images in.
|
||||
- The minimum number of scanlines required to be in an image, after noise cropping, for it to be automatically saved.
|
||||
- After how many scanlines image processing is applied and updates sent to the map. Lower values require more CPU power.
|
||||
|
@ -10,6 +10,8 @@ Experimental modes with smaller number of lines and FPS values can be used in co
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
The interface is divided into three collapsable sections:
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to listen to a Broadcast FM modulated signal (BFM). In a
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
The main three areas are:
|
||||
|
@ -23,6 +23,8 @@ Note: this plugin is officially supported since version 6.
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -8,6 +8,8 @@ The DAB demodulator uses a sample rate of 2.048MHz.
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -18,6 +18,8 @@ The whole bandwidth available to the channel is used. That is it runs at the dev
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>A: RF settings</h3>
|
||||
|
@ -52,6 +52,8 @@ For software built from source if you choose to have `mbelib` support you will n
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>A section: settings</h3>
|
||||
|
@ -8,6 +8,8 @@ This plugin can be used to demodulate a signal following the [FreeDV digital voi
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to listen to a narrowband FM modulated signal. "Narrowba
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception value</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to demodulate packet radio (APRS/AX.25) data packets. Re
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to demodulate POCSAG pager messages.
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -4,12 +4,14 @@
|
||||
|
||||
This plugin can be used to demodulate RS41 radiosonde weather balloon signals. Radiosondes typically transmit on 400-406MHz and are in the sky around the world for around 1 hour around 00:00 UTC.
|
||||
|
||||
RS41 radiosondes transmit data frames every second, containing position, velocity and PTU (Pressure, Temperature and Humidity) readings. The radios use GFSK modulation, with ±2.4kHz deviation at 4,800 baud. Reed Solomon encoding is used for ECC (Error Checking and Correction).
|
||||
RS41 radiosondes transmit data frames every second, containing position, velocity and PTU (Pressure, Temperature and Humidity) readings. The radios use GFSK modulation, with <EFBFBD>2.4kHz deviation at 4,800 baud. Reed Solomon encoding is used for ECC (Error Checking and Correction).
|
||||
|
||||
The Radiosonde demodulator can forward received data to the [Radiosone feature](../../feature/radiosonde/readme.md), which can plot charts showing how altitude and PTU vary over time, and also plot the position of the radiosonde on the 2D and 3D maps.
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
@ -81,18 +83,18 @@ The received frames table displays information about each radiosonde frame recei
|
||||
* Serial - The serial number of the radiosonde. Double clicking on this column will search for the radiosone on https://sondehub.org/
|
||||
* Frame - Frame number
|
||||
* Phase - Flight phase: On ground, Ascent and Descent.
|
||||
* Lat (°) - Latitude in degrees, North positive. Double clicking on this column will search for the radiosonde on the Map.
|
||||
* Lon (°) - Longitude in degrees, East positive. Double clicking on this column will search for the radiosonde on the Map.
|
||||
* Lat (<EFBFBD>) - Latitude in degrees, North positive. Double clicking on this column will search for the radiosonde on the Map.
|
||||
* Lon (<EFBFBD>) - Longitude in degrees, East positive. Double clicking on this column will search for the radiosonde on the Map.
|
||||
* Alt (m) - Altitude in metres.
|
||||
* Spd (km/h) - Speed over ground in kilometres per hour.
|
||||
* VR (m/s) - Vertical climb rate in metres per second.
|
||||
* Hdg (°) - Heading in degrees.
|
||||
* Hdg (<EFBFBD>) - Heading in degrees.
|
||||
* P (hPA) - Air pressure in hectopascals. Not all RS41s include a pressure sensor. A value ending with 'U' indicates a uncalibrated estimate and may be inaccurate.
|
||||
* T (°C) - Air temperature in degrees Celsius. A value ending with 'U' indicates a uncalibrated estimate and may be inaccurate.
|
||||
* T (<EFBFBD>C) - Air temperature in degrees Celsius. A value ending with 'U' indicates a uncalibrated estimate and may be inaccurate.
|
||||
* U (%) - Relative humidity in percent. A value ending with 'U' indicates a uncalibrated estimate and may be inaccurate.
|
||||
* Bat (V) - Battery voltage in Volts.
|
||||
* Bat - Battery status: OK or low.
|
||||
* PCB (°C) - Temperature of PCB.
|
||||
* PCB (<EFBFBD>C) - Temperature of PCB.
|
||||
* PWM (%) - Humidity sensor heater PWM (Pulse Width Modulation) setting, in percent.
|
||||
* TX (%) - Transmit power in percent.
|
||||
* Max SF - Maximum subframe number.
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to listen to a single sideband or double sidebands modul
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
☞ In order to toggle USB or LSB mode in SSB mode you have to set the "BW" in channel filter cutoff control (9) to a positive (USB) or negative (LSB) value. The above screenshot shows a LSB setup. See the (8) to (10) paragraphs below for details.
|
||||
|
@ -16,6 +16,8 @@ Note that for aircraft, there is typically a direct line-of-sight to the VOR. Th
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Level meter in dB</h3>
|
||||
|
@ -18,6 +18,8 @@ Several instances of this plugin can be created to monitor multiple VORs and col
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception value</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to listen to a wideband or narrowband FM modulated signa
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -18,6 +18,8 @@ If a filename is given with an extension different of `.sdriq` or `.wav` then th
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -8,6 +8,8 @@ This plugin can be used to track the center frequency of a carrier. It will try
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -16,6 +16,8 @@ Note that because it uses only the channelizer half band filter chain to achieve
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Decimation factor</h3>
|
||||
|
@ -10,6 +10,8 @@ The noise figure will vary with frequency and gain settings. Typically, the nois
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Measurement frequency shift from center</h3>
|
||||
|
@ -90,6 +90,8 @@ Where:
|
||||
|
||||
<h2>1: Settings</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1.1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -17,6 +17,8 @@ Although the atomic clocks used to transmit the timecode are extremely accurate,
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -10,6 +10,8 @@ The plugin will be built only if the [CM256cc library](https://github.com/f4exb/
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Decimation factor</h3>
|
||||
|
@ -19,6 +19,8 @@ It adds a dependency to the [libsigmf library](https://github.com/f4exb/libsigmf
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -12,6 +12,8 @@ This plugin is available for Linux and Mac O/S only.
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -50,6 +50,8 @@ The I/Q samples are copied to the baseband to be transmitted by the sink output
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Interpolation factor</h3>
|
||||
|
@ -10,6 +10,8 @@ Note that because it uses only the channelizer half band filter chain to achieve
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Interpolation factor</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to transmit IEEE 802.15.4 frames. The 802.15.4 PHY & RF
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of transmission</h3>
|
||||
|
@ -8,6 +8,8 @@ You need an AIS license to transmit on the AIS VHF frequencies (161.975MHz and 1
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of transmission</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to generate a narrowband amplitude modulated signal. "Na
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of transmission</h3>
|
||||
|
@ -10,6 +10,8 @@ In practice 4 MS/s with about 300 points per line is the lowest sample rate that
|
||||
|
||||
<h1>Interface</h1>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h2>1: Frequency shift from center frequency of transmission</h2>
|
||||
|
@ -19,6 +19,8 @@ Note: this plugin is officially supported since version 6.
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -15,6 +15,8 @@ DVB-S2 includes: scrambling, BCH encoder, LDPC encoder, bit interleaver and QPSK
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of transmission</h3>
|
||||
|
@ -8,6 +8,8 @@ This plugin can be used to generate a signal following the [FreeDV digital voice
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of transmission</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to generate a narrowband frequency modulated signal. "Na
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of transmission</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to modulate packet radio (APRS/AX.25) data packets.
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of transmission</h3>
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to generate a single sideband or double sidebands modula
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
☞ In order to toggle USB or LSB mode in SSB mode you have to set the "BW" in channel filter cutoff control (8) to a positive (USB) or negative (LSB) value. The above screenshot shows a USB setup. See the (7) to (9) paragraphs below for details.
|
||||
|
@ -6,6 +6,8 @@ This plugin can be used to generate a wideband frequency modulated signal. "Wide
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of transmission</h3>
|
||||
|
@ -10,6 +10,8 @@ The plugin will be built only if the [CM256cc library](https://github.com/f4exb/
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Data local address</h2>
|
||||
|
@ -10,6 +10,8 @@ This plugin is available for Linux and Mac O/S only.
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
The top and bottom bars of the channel window are described [here](../../../sdrgui/channel/readme.md)
|
||||
|
||||

|
||||
|
||||
<h3>1: Frequency shift from center frequency of reception</h3>
|
||||
|
@ -329,9 +329,14 @@ void ChannelGUI::setDeviceType(DeviceType type)
|
||||
updateIndexLabel();
|
||||
}
|
||||
|
||||
void ChannelGUI::setDisplayedame(const QString& name)
|
||||
{
|
||||
m_displayedName = name;
|
||||
}
|
||||
|
||||
void ChannelGUI::setToolTip(const QString& tooltip)
|
||||
{
|
||||
m_indexLabel->setToolTip(tooltip);
|
||||
m_indexLabel->setToolTip(tr("%1 / %2").arg(tooltip).arg(m_displayedName));
|
||||
}
|
||||
|
||||
void ChannelGUI::setIndex(int index)
|
||||
|
@ -75,6 +75,7 @@ public:
|
||||
void setTitle(const QString& title);
|
||||
void setTitleColor(const QColor& c);
|
||||
void setDeviceType(DeviceType type);
|
||||
void setDisplayedame(const QString& name);
|
||||
DeviceType getDeviceType() const { return m_deviceType; }
|
||||
void setToolTip(const QString& tooltip);
|
||||
void setIndex(int index);
|
||||
@ -97,6 +98,7 @@ protected:
|
||||
QString m_helpURL;
|
||||
RollupContents* m_rollupContents;
|
||||
ContextMenuType m_contextMenuType;
|
||||
QString m_displayedName;
|
||||
|
||||
protected slots:
|
||||
void shrinkWindow();
|
||||
|
165
sdrgui/channel/readme.md
Normal file
165
sdrgui/channel/readme.md
Normal file
@ -0,0 +1,165 @@
|
||||
<h1>Channel common controls</h1>
|
||||
|
||||
The channel windows have common top and bottom bars
|
||||
|
||||

|
||||
|
||||
<h2>A: Top bar</h2>
|
||||
|
||||

|
||||
|
||||
<h3>A.1: Index</h3>
|
||||
|
||||
The format is:
|
||||
|
||||
- Device reference to which the channel is attached. This is the device type and its index. See [device window documentation](../device/readme.md)
|
||||
- Semicolon separator
|
||||
- Channel index in device set
|
||||
|
||||
Aditionally when the channel is a single stream channel and attached to a MIMO device:
|
||||
|
||||
- Dot separator
|
||||
- Stream index
|
||||
|
||||
The tooltip shows the device type to which the channel is attached, its sequence number and serial number of the device if it exists. It also displays the channel type separated by a slash. For example: `HackRF[0] 88869dc3878a51 / SSB Demodulator`
|
||||
|
||||
You may click on this area and drag the window with the mouse.
|
||||
|
||||
<h3>A.2: Common channel settings</h3>
|
||||
|
||||
Opens a dialog to update the common channel settings
|
||||
|
||||

|
||||
|
||||
<h4>A.2.1: Window title</h4>
|
||||
|
||||
Changes the channel window title
|
||||
|
||||
<h4>A.2.2: Channel color</h4>
|
||||
|
||||
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.
|
||||
|
||||
<h4>A.2.3: Frequency scale display type</h4>
|
||||
|
||||
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:
|
||||
|
||||
- Freq: channel absolute center frequency
|
||||
- Title: channel window title
|
||||
- AdSnd: UDP address and send port
|
||||
- AdRcv: UDP address and receive port
|
||||
|
||||
<h4>A.2.4: Toggle reverse API feature</h4>
|
||||
|
||||
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:
|
||||
|
||||
```
|
||||
{
|
||||
"SSBDemodSettings": {
|
||||
"agc": 0,
|
||||
"agcClamping": 0,
|
||||
"agcPowerThreshold": -40,
|
||||
"agcThresholdGate": 4,
|
||||
"agcTimeLog2": 7,
|
||||
"audioBinaural": 0,
|
||||
"audioDeviceName": "System default device",
|
||||
"audioFlipChannels": 0,
|
||||
"audioMute": 0,
|
||||
"dsb": 0,
|
||||
"inputFrequencyOffset": 0,
|
||||
"lowCutoff": 300,
|
||||
"rfBandwidth": 3000,
|
||||
"rgbColor": -16711936,
|
||||
"spanLog2": 3,
|
||||
"title": "SSB Demodulator",
|
||||
"volume": 3
|
||||
},
|
||||
"channelType": "SSBDemod",
|
||||
"tx": 0
|
||||
}
|
||||
```
|
||||
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.
|
||||
|
||||
More details on this feature can be found on the corresponding Wiki page.
|
||||
|
||||
<h4>A.2.5: API address</h4>
|
||||
|
||||
This is the IP address of the API endpoint
|
||||
|
||||
<h4>A.2.6: API port</h4>
|
||||
|
||||
This is the IP port of the API endpoint
|
||||
|
||||
<h4>A.2.7: Device index</h4>
|
||||
|
||||
This is the targeted device index
|
||||
|
||||
<h4>A.2.8: Channel index</h4>
|
||||
|
||||
This is the targeted channel index
|
||||
|
||||
<h4>A.2.9: Cancel changes and exit dialog</h4>
|
||||
|
||||
Do not make any changes and exit dialog
|
||||
|
||||
<h4>A.2.10: Validate and exit dialog</h4>
|
||||
|
||||
Validates the data (saves it in the channel marker object) and exits the dialog
|
||||
|
||||
<h3>A.3: Title</h3>
|
||||
|
||||
This is the default channel title or as set with (A.2.1).
|
||||
|
||||
You may click on this area and drag the window with the mouse.
|
||||
|
||||
<h3>A.4: Help</h3>
|
||||
|
||||
Clicking on this button opens the documentation about the channel controls in github in the browser.
|
||||
|
||||
<h3>A.5: Move to another workspace</h3>
|
||||
|
||||
Opens a dialog to choose a destination workspace to move the channel window to. Nothing happens if the same workspace is selected.
|
||||
|
||||
<h3>A.6: Shrink window</h3>
|
||||
|
||||
Click this button to reduce the window to its minimum size
|
||||
|
||||
<h3>A.7: Hide window</h3>
|
||||
|
||||
Click this button to hide the channel window
|
||||
|
||||
<h3>A.8: Close window</h3>
|
||||
|
||||
Click this button to close the window and removes the channel from the device set.
|
||||
|
||||
<h3>A.9: Top size grip</h3>
|
||||
|
||||
You can drag this gray square to resize the window
|
||||
|
||||
<h2>B: Bottom bar</h2>
|
||||
|
||||

|
||||
|
||||
<h3>B.1: Duplicate channel</h3>
|
||||
|
||||
Creates a new channel with the same settings
|
||||
|
||||
<h3>B.2: Attach channel to another device</h3>
|
||||
|
||||
Opens a dialog to select the destination device. Nothing happens if the destination device is the same as the current device.
|
||||
|
||||
<h3>B.3: Absolute channel center frequency</h3>
|
||||
|
||||
This is the absolute frequency in Hz of the channel center. It is the sum of the device center frequency and the channel shift.
|
||||
|
||||
You may click on this area and drag the window with the mouse.
|
||||
|
||||
<h3>B.4: Status message</h3>
|
||||
|
||||
The status messages appear here if any.
|
||||
|
||||
You may click on this area and drag the window with the mouse.
|
||||
|
||||
<h3>B.5: Bottom size grip</h3>
|
||||
|
||||
You can drag this gray square to resize the window
|
||||
|
@ -298,8 +298,10 @@ void DeviceUISet::loadRxChannelSettings(const Preset *preset, PluginAPI *pluginA
|
||||
qPrintable((*channelRegistrations)[i].m_channelIdURI),
|
||||
qPrintable(channelConfig.m_channelIdURI));
|
||||
BasebandSampleSink *rxChannel;
|
||||
(*channelRegistrations)[i].m_plugin->createRxChannel(m_deviceAPI, &rxChannel, &channelAPI);
|
||||
rxChannelGUI = (*channelRegistrations)[i].m_plugin->createRxChannelGUI(this, rxChannel);
|
||||
PluginInterface *pluginInterface = (*channelRegistrations)[i].m_plugin;
|
||||
pluginInterface->createRxChannel(m_deviceAPI, &rxChannel, &channelAPI);
|
||||
rxChannelGUI = pluginInterface->createRxChannelGUI(this, rxChannel);
|
||||
rxChannelGUI->setDisplayedame(pluginInterface->getPluginDescriptor().displayedName);
|
||||
registerRxChannelInstance(channelAPI, rxChannelGUI);
|
||||
QObject::connect(
|
||||
rxChannelGUI,
|
||||
@ -424,8 +426,10 @@ void DeviceUISet::loadTxChannelSettings(const Preset *preset, PluginAPI *pluginA
|
||||
qPrintable((*channelRegistrations)[i].m_channelIdURI),
|
||||
qPrintable(channelConfig.m_channelIdURI));
|
||||
BasebandSampleSource *txChannel;
|
||||
(*channelRegistrations)[i].m_plugin->createTxChannel(m_deviceAPI, &txChannel, &channelAPI);
|
||||
txChannelGUI = (*channelRegistrations)[i].m_plugin->createTxChannelGUI(this, txChannel);
|
||||
PluginInterface *pluginInterface = (*channelRegistrations)[i].m_plugin;
|
||||
pluginInterface->createTxChannel(m_deviceAPI, &txChannel, &channelAPI);
|
||||
txChannelGUI = pluginInterface->createTxChannelGUI(this, txChannel);
|
||||
txChannelGUI->setDisplayedame(pluginInterface->getPluginDescriptor().displayedName);
|
||||
registerTxChannelInstance(channelAPI, txChannelGUI);
|
||||
QObject::connect(
|
||||
txChannelGUI,
|
||||
@ -551,9 +555,10 @@ void DeviceUISet::loadMIMOChannelSettings(const Preset *preset, PluginAPI *plugi
|
||||
qPrintable((*channelRegistrations)[i].m_channelIdURI),
|
||||
qPrintable(channelConfig.m_channelIdURI));
|
||||
MIMOChannel *mimoChannel;
|
||||
(*channelRegistrations)[i].m_plugin->createMIMOChannel(m_deviceAPI, &mimoChannel, &channelAPI);
|
||||
mimoChannelGUI = (*channelRegistrations)[i].m_plugin->createMIMOChannelGUI(this, mimoChannel);
|
||||
(*channelRegistrations)[i].m_plugin->createMIMOChannel(m_deviceAPI, &mimoChannel, &channelAPI);
|
||||
PluginInterface *pluginInterface = (*channelRegistrations)[i].m_plugin;
|
||||
pluginInterface->createMIMOChannel(m_deviceAPI, &mimoChannel, &channelAPI);
|
||||
mimoChannelGUI = pluginInterface->createMIMOChannelGUI(this, mimoChannel);
|
||||
mimoChannelGUI->setDisplayedame(pluginInterface->getPluginDescriptor().displayedName);
|
||||
registerChannelInstance(channelAPI, mimoChannelGUI);
|
||||
QObject::connect(
|
||||
mimoChannelGUI,
|
||||
|
@ -2,14 +2,13 @@
|
||||
|
||||
The device windows have common top and bottom bars
|
||||
|
||||
|
||||

|
||||
|
||||
<h2>A: Top bar</h2>
|
||||
|
||||

|
||||
|
||||
<h3>A.1 Devcice type and index</h3>
|
||||
<h3>A.1 Device type and index</h3>
|
||||
|
||||
The format is:
|
||||
- Device type:
|
||||
@ -19,7 +18,7 @@ The format is:
|
||||
- Semicolon separator
|
||||
- Device set index. A "device set" is the set of a device and its corresponding channels
|
||||
|
||||
THe tooltip shows the device type, sequence number and serial number of the device if it exists.
|
||||
The tooltip shows the device type, sequence number and serial number of the device if it exists.
|
||||
|
||||
You may click on this area and drag the window with the mouse.
|
||||
|
||||
@ -185,7 +184,7 @@ You may click on this area and drag the window with the mouse.
|
||||
|
||||
Clicking on this button opens the documentation about the device controls in github in the browser.
|
||||
|
||||
<h3>A.9: Move to a workspace</h3>
|
||||
<h3>A.9: Move to another workspace</h3>
|
||||
|
||||
Opens a dialog to choose a destination workspace to move the device window to. Nothing happens if the same workspace is selected.
|
||||
|
||||
@ -195,13 +194,13 @@ Click this button to reduce the window to its minimum size
|
||||
|
||||
<h3>A.11: Close window</h3>
|
||||
|
||||
Click this button to close the window and removes the channel from the device set.
|
||||
Click this button to close the window and removes the device set i.e. the device and all its channels.
|
||||
|
||||
<h3>A.12: Top size grip</h3>
|
||||
|
||||
You can drag this gray square to resize the window
|
||||
|
||||
<h2>B: Botom bar</h2>
|
||||
<h2>B: Bottom bar</h2>
|
||||
|
||||

|
||||
|
||||
|
@ -2362,6 +2362,7 @@ void MainWindow::channelAddClicked(Workspace *workspace, int deviceSetIndex, int
|
||||
deviceUI->registerRxChannelInstance(channelAPI, gui);
|
||||
gui->setDeviceType(ChannelGUI::DeviceRx);
|
||||
gui->setIndex(channelAPI->getIndexInDeviceSet());
|
||||
gui->setDisplayedame(pluginInterface->getPluginDescriptor().displayedName);
|
||||
}
|
||||
else if (deviceUI->m_deviceSinkEngine) // sink device => Tx channels
|
||||
{
|
||||
@ -2374,6 +2375,7 @@ void MainWindow::channelAddClicked(Workspace *workspace, int deviceSetIndex, int
|
||||
deviceUI->registerTxChannelInstance(channelAPI, gui);
|
||||
gui->setDeviceType(ChannelGUI::DeviceTx);
|
||||
gui->setIndex(channelAPI->getIndexInDeviceSet());
|
||||
gui->setDisplayedame(pluginInterface->getPluginDescriptor().displayedName);
|
||||
}
|
||||
else if (deviceUI->m_deviceMIMOEngine) // MIMO device => all possible channels. Depends on index range
|
||||
{
|
||||
@ -2393,6 +2395,7 @@ void MainWindow::channelAddClicked(Workspace *workspace, int deviceSetIndex, int
|
||||
gui = pluginInterface->createMIMOChannelGUI(deviceUI, mimoChannel);
|
||||
deviceUI->registerChannelInstance(channelAPI, gui);
|
||||
gui->setIndex(channelAPI->getIndexInDeviceSet());
|
||||
gui->setDisplayedame(pluginInterface->getPluginDescriptor().displayedName);
|
||||
}
|
||||
else if (channelPluginIndex < nbMIMOChannels + nbRxChannels) // Rx
|
||||
{
|
||||
@ -2404,6 +2407,7 @@ void MainWindow::channelAddClicked(Workspace *workspace, int deviceSetIndex, int
|
||||
gui = pluginInterface->createRxChannelGUI(deviceUI, rxChannel);
|
||||
deviceUI->registerRxChannelInstance(channelAPI, gui);
|
||||
gui->setIndex(channelAPI->getIndexInDeviceSet());
|
||||
gui->setDisplayedame(pluginInterface->getPluginDescriptor().displayedName);
|
||||
}
|
||||
else if (channelPluginIndex < nbMIMOChannels + nbRxChannels + nbTxChannels)
|
||||
{
|
||||
@ -2415,6 +2419,7 @@ void MainWindow::channelAddClicked(Workspace *workspace, int deviceSetIndex, int
|
||||
gui = pluginInterface->createTxChannelGUI(deviceUI, txChannel);
|
||||
deviceUI->registerTxChannelInstance(channelAPI, gui);
|
||||
gui->setIndex(channelAPI->getIndexInDeviceSet());
|
||||
gui->setDisplayedame(pluginInterface->getPluginDescriptor().displayedName);
|
||||
}
|
||||
|
||||
gui->setDeviceType(ChannelGUI::DeviceMIMO);
|
||||
|
Loading…
x
Reference in New Issue
Block a user