mirror of
https://github.com/f4exb/sdrangel.git
synced 2024-11-22 08:04:49 -05:00
Updated documentation (1)
This commit is contained in:
f4exb
parent
081510ef69
commit
4d36cba7a8
Binary file not shown.
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
BIN
doc/img/BasicChannelSettings.png
Normal file
BIN
doc/img/BasicChannelSettings.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 115 KiB After Width: | Height: | Size: 115 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 22 KiB |
@ -12,14 +12,20 @@ This plugin can be used to listen to a narrowband amplitude modulated signal. "N
|
||||
|
||||
Use the wheels to adjust the frequency shift in Hz from the center frequency of reception. 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 arroews. Pressing shift simultanoeusly moves digit by 5 and pressing control moves it by 2.
|
||||
|
||||
<h3>3: Channel power</h3>
|
||||
<h3>2: Channel power</h3>
|
||||
|
||||
Average total power in dB relative to a +/- 1.0 amplitude signal received in the pass band.
|
||||
|
||||
<h3>4: Audio mute</h3>
|
||||
<h3>3: Audio mute</h3>
|
||||
|
||||
Use this button to toggle audio mute for this channel. The button will light up in green if the squelch is open. This helps identifying which channels are active in a multi-channel configuration.
|
||||
|
||||
<h3>4: UDP output</h3>
|
||||
|
||||
Copies audio output to UDP. Audio is set at fixed level and is muted by the mute button (13) and squelch (9) is also applied. Output is mono S16LE samples.
|
||||
|
||||
UDP address and send port are specified in the basic channel settings. See: [here](https://github.com/f4exb/sdrangel/blob/master/sdrbase/readme.md#6-channels)
|
||||
|
||||
<h3>5: Level meter in dB</h3>
|
||||
|
||||
- top bar (green): average value
|
||||
|
||||
@ -179,57 +179,69 @@ Number of milliseconds following squelch gate opening after which the signal is
|
||||
|
||||
Audio mute toggle button. This button lights in green when the squelch opens.
|
||||
|
||||
<h3>19: Format specific status display</h3>
|
||||
<h3>19: UDP output</h3>
|
||||
|
||||
Copies audio output to UDP. Output is stereo S16LE samples. Depending on which slots are active the output is the following:
|
||||
|
||||
- Slot 1: slot 1 on left channel
|
||||
- Slot 2: slot 2 on right channel
|
||||
- Slot 1+2: slot 1 on left channel
|
||||
|
||||
It cannot mix both channels when slot1+2 are active.
|
||||
|
||||
UDP address and send port are specified in the basic channel settings. See: [here](https://github.com/f4exb/sdrangel/blob/master/sdrbase/readme.md#6-channels)
|
||||
|
||||
<h3>20: Format specific status display</h3>
|
||||
|
||||
When the display is active the background turns from the surrounding gray color to dark green. It shows informatory or status messages that are particular to each format.
|
||||
|
||||
<h4>19.1: D-Star status display</h4>
|
||||
<h4>20.1: D-Star status display</h4>
|
||||
|
||||
|
||||
|
||||
<h5>19.1.1: Origin (my) and destination (your) callsign</h5>
|
||||
<h5>20.1.1: Origin (my) and destination (your) callsign</h5>
|
||||
|
||||
- at the left of the `>` sign is the origin callsign ` MY` with the 4 character informative suffix nest to the slash `/`
|
||||
- at the right of the `>` sign is the destination callsign `YOUR`. As per Icom standard this is `CQCQCQ` when a call is made to all stations
|
||||
- this information is retrieved from the header or the slow data if it can be decoded
|
||||
|
||||
<h5>19.1.2: Repeater callsign</h5>
|
||||
<h5>20.1.2: Repeater callsign</h5>
|
||||
|
||||
- at the left of the `>` sign is the origin repeater or `RPT1`
|
||||
- at the right of the `>` sign is the destination repeater or `RPT2`
|
||||
- this information is retrieved from the header or the slow data if it can be decoded
|
||||
|
||||
<h5>19.1.3: Informative text</h5>
|
||||
<h5>20.1.3: Informative text</h5>
|
||||
|
||||
When slow data can be decoded this is the 20 character string that is sent in the text frames
|
||||
|
||||
<h5>19.1.4: Geopositional data</h5>
|
||||
<h5>20.1.4: Geopositional data</h5>
|
||||
|
||||
When a `$$CRC` frame that carries geographical position can be successfully decoded from the slow data the geopositional information is displayed:
|
||||
|
||||
- at the left of the colon `:` is the QTH 6 character locator a.k.a. Maidenhead locator
|
||||
- at the right of the colon `:` is the bearing in degrees and distance in kilometers from the location entered in the main window `Preferences\My Position` dialog. The bearing and distance are separated by a slash `/`.
|
||||
|
||||
<h4>19.2: DMR status display</h4>
|
||||
<h4>20.2: DMR status display</h4>
|
||||
|
||||
|
||||
|
||||
- Note 1: statuses are polled at ~1s rate and therefore do not reflect values instantaneously. As a consequence some block types that occur during the conversation may not appear.
|
||||
- Note 2: status values remain unchanged until a new value is available for the channel or the transmissions stops then all values of both channels are cleared
|
||||
|
||||
<h5>19.2.1: Station role</h5>
|
||||
<h5>20.2.1: Station role</h5>
|
||||
|
||||
- `BS`: base station
|
||||
- `MS`: mobile station
|
||||
- `NA`: not applicable or could not be determined (you should not see this normally)
|
||||
|
||||
<h5>19.2.2: TDMA slot #0 status</h5>
|
||||
<h5>20.2.2: TDMA slot #0 status</h5>
|
||||
|
||||
For mobile stations on an inbound channel there is no channel identification (no CACH) so information goes there by default.
|
||||
|
||||
<h5>19.2.3: TDMA slot #1 status</h5>
|
||||
<h5>20.2.3: TDMA slot #1 status</h5>
|
||||
|
||||
<h5>19.2.4: Channel status and color code</h5>
|
||||
<h5>20.2.4: Channel status and color code</h5>
|
||||
|
||||
This applies to base stations and mobile stations in continuous mode that is transmissions including the CACH sequences.
|
||||
|
||||
@ -244,7 +256,7 @@ This applies to base stations and mobile stations in continuous mode that is tra
|
||||
- The color code from 0 to 15 (4 bits)
|
||||
- `--`: The color code could not be decoded and information is missing
|
||||
|
||||
<h5>19.2.5: Slot type</h5>
|
||||
<h5>20.2.5: Slot type</h5>
|
||||
|
||||
This is either:
|
||||
|
||||
@ -262,7 +274,7 @@ This is either:
|
||||
- `RES`: reserved data block
|
||||
- `UNK`: unknown data type or could not be decoded
|
||||
|
||||
<h5>19.2.6: Addressing information</h5>
|
||||
<h5>20.2.6: Addressing information</h5>
|
||||
|
||||
String is in the form: `02223297>G00000222`
|
||||
|
||||
@ -272,11 +284,11 @@ String is in the form: `02223297>G00000222`
|
||||
- `U`: unit (individual) address
|
||||
- Next on the right is the target address (24 bits) as defined in the DMR ETSI standard
|
||||
|
||||
<h4>19.3: dPMR status display</h4>
|
||||
<h4>20.3: dPMR status display</h4>
|
||||
|
||||
|
||||
|
||||
<h5>19.3.1: dPMR frame tyoe</h5>
|
||||
<h5>20.3.1: dPMR frame tyoe</h5>
|
||||
|
||||
- `--`: undetermined
|
||||
- `HD`: Header of FS1 type
|
||||
@ -288,23 +300,23 @@ String is in the form: `02223297>G00000222`
|
||||
- `XS`: Extended search: looking for a new payload frame when out of sequence
|
||||
- `EN`: End frame
|
||||
|
||||
<h5>19.3.2: Colour code</h5>
|
||||
<h5>20.3.2: Colour code</h5>
|
||||
|
||||
Colour code in decimal (12 bits)
|
||||
|
||||
<h5>19.3.3: Own ID</h5>
|
||||
<h5>20.3.3: Own ID</h5>
|
||||
|
||||
Sender's identification code in decimal (24 bits)
|
||||
|
||||
<h5>19.3.4: Called ID</h5>
|
||||
<h5>20.3.4: Called ID</h5>
|
||||
|
||||
Called party's identification code in decimal (24 bits)
|
||||
|
||||
<h4>19.4: Yaesu System Fusion (YSF) status display</h4>
|
||||
<h4>20.4: Yaesu System Fusion (YSF) status display</h4>
|
||||
|
||||
|
||||
|
||||
<h5>19.4.1: FICH data</h5>
|
||||
<h5>20.4.1: FICH data</h5>
|
||||
|
||||
This displays a summary of FICH (Frame Identification CHannel) block data. From left to right:
|
||||
|
||||
@ -337,23 +349,23 @@ This displays a summary of FICH (Frame Identification CHannel) block data. From
|
||||
- `L`: local path (as inthe example)
|
||||
- last three characters are the YSF squelch code (0..127) or dashes `---` if the YSF squelch is not active
|
||||
|
||||
<h5>19.4.2: Origin and destination callsigns</h5>
|
||||
<h5>20.4.2: Origin and destination callsigns</h5>
|
||||
|
||||
- at the left of the `>` sign is the origin callsign
|
||||
- at the right of the `>` sign is the destination callsign. It is filled with stars `*` when call is made to all stations (similar to the CQCQCQ in D-Star)
|
||||
|
||||
<h5>19.4.3: Origin and destination repeaters callsigns</h5>
|
||||
<h5>20.4.3: Origin and destination repeaters callsigns</h5>
|
||||
|
||||
- at the left of the `>` sign is the origin repeater callsign
|
||||
- at the right of the `>` sign is the destination repeater callsign.
|
||||
|
||||
<h5>19.4.4: Originator radio ID</h5>
|
||||
<h5>20.4.4: Originator radio ID</h5>
|
||||
|
||||
This is the unique character string assigned to the device by the manufacturer.
|
||||
|
||||
<h3>20: Discriminator output scope display</h3>
|
||||
<h3>21: Discriminator output scope display</h3>
|
||||
|
||||
<h4>20.1 Transitions constellation display</h4>
|
||||
<h4>21.1 Transitions constellation display</h4>
|
||||
|
||||
This is selected by the transition constellation or symbol synchronization signal toggle (see 7)
|
||||
|
||||
@ -369,18 +381,18 @@ This allows the visualization of symbol transitions which depend on the type of
|
||||
|
||||
|
||||
|
||||
<h5>20.1.1: Setting the display</h5>
|
||||
<h5>21.1.1: Setting the display</h5>
|
||||
|
||||
- On the combo box you should choose IQ (lin) for the primary display and IQ (pol) for secondary display
|
||||
- On the display buttons you should choose the side by side display
|
||||
|
||||
On the same line you can choose any trace length. If it is too short the constellation points will not appear clearly and if it is too long the polar figure will be too dense. Usually 100ms give good results.
|
||||
|
||||
<h5>20.1.2: IQ linear display</h5>
|
||||
<h5>21.1.2: IQ linear display</h5>
|
||||
|
||||
The yellow trace (I) is the direct trace and the blue trace (Q) is the delayed trace. This can show how symbols differentiate between each other in a sort of eye diagram.
|
||||
|
||||
<h5>20.1.3: IQ polar display</h5>
|
||||
<h5>21.1.3: IQ polar display</h5>
|
||||
|
||||
This shows the constellation of transition points. You should adjust the frequency shift to center the figure and the maximum deviation and/or discriminator gain to contain the figure within the +/-0.4 square. +/- 0.1 to +/- 0.3 usually give the best results.
|
||||
|
||||
@ -416,48 +428,48 @@ There are 16 possible points corresponding to the 16 possible transitions betwee
|
||||
|
||||
Because not all transitions are possible similarly to the 2-FSK case pointer moves from the lower left side of the diagonal to the upper right side are not possible.
|
||||
|
||||
<h5>20.1.4: I gain</h5>
|
||||
<h5>21.1.4: I gain</h5>
|
||||
|
||||
You should set the slider to a unity (1) span (+/- 0.5) with no offset. This corresponds to full range in optimal conditions (100%). You can set the slider fully to the left (2) for a +/- 1.0 spn if you don't exactly match these conditions.
|
||||
|
||||
<h5>20.1.5: Q gain</h5>
|
||||
<h5>21.1.5: Q gain</h5>
|
||||
|
||||
You should set the slider to a unity (1) span (+/- 0.5) with no offset. This corresponds to full range in optimal conditions (100%). You can set the slider fully to the left (2) for a +/- 1.0 spn if you don't exactly match these conditions.
|
||||
|
||||
<h5>20.1.6: Trigger settings</h5>
|
||||
<h5>21.1.6: Trigger settings</h5>
|
||||
|
||||
You can leave the trigger free running or set it to I linear with a 0 threshold.
|
||||
|
||||
<h4>20.2: Symbol synchronization display</h4>
|
||||
<h4>21.2: Symbol synchronization display</h4>
|
||||
|
||||
This is selected by the transition constellation or symbol synchronization signal toggle (see 7)
|
||||
|
||||
|
||||
|
||||
<h5>20.2.1: IQ linear display</h5>
|
||||
<h5>21.2.1: IQ linear display</h5>
|
||||
|
||||
The I trace (yellow) is the discriminator signal and the Q trace (blue) is the symbol synchronization monitor trace that goes to the estimated maximum discriminator signal level when a zero crossing in the symbol synchronization control signal is detected and goes to mid position ((max - min) / 2) of the discriminator signal when a symbol period starts.
|
||||
|
||||
The symbol synchronization control signal is obtained by squaring the discriminator signal and passing it through a narrow second order bandpass filter centered on the symbol rate. Its zero crossing should occur close to the first fourth of a symbol period therefore when synchronization is ideal the Q trace (blue) should go down to mid position in the first fourth of the symbol period.
|
||||
|
||||
<h5>20.2.2: Setting the display</h5>
|
||||
<h5>21.2.2: Setting the display</h5>
|
||||
|
||||
- On the combo box you should choose IQ (lin) for the primary display and IQ (pol) for secondary display
|
||||
- On the display buttons you should choose the first display (1)
|
||||
|
||||
<h5>20.2.3: Timing settings</h5>
|
||||
<h5>21.2.3: Timing settings</h5>
|
||||
|
||||
You can choose any trace length with the third slider from the left however 100 ms will give you the best view. You may stretch further the display by reducing the full length to 20 ms or less using the first slider. You can move this 20 ms window across the 100 ms trace with the middle slider.
|
||||
|
||||
<h5>20.2.4: I gain</h5>
|
||||
<h5>21.2.4: I gain</h5>
|
||||
|
||||
You should set the slider to a unity (1) span (+/- 0.5) with no offset. This corresponds to full range in optimal conditions (100%). You can set the slider fully to the left (2) for a +/- 1.0 spn if you don't exactly match these conditions.
|
||||
|
||||
<h5>20.2.5: Q gain</h5>
|
||||
<h5>21.2.5: Q gain</h5>
|
||||
|
||||
You should set the slider to a unity (1) span (+/- 0.5) with no offset. This corresponds to full range in optimal conditions (100%). You can set the slider fully to the left (2) for a +/- 1.0 spn if you don't exactly match these conditions.
|
||||
|
||||
<h5>20.2.6: Trigger settings</h5>
|
||||
<h5>21.2.6: Trigger settings</h5>
|
||||
|
||||
You can leave the trigger free running or set it to I linear with a 0 threshold.
|
||||
|
||||
|
||||
@ -60,4 +60,10 @@ This is the value of the tone squelch received when the CTCSS is activated. It d
|
||||
|
||||
<h3>13: Audio mute</h3>
|
||||
|
||||
Use this button to toggle audio mute for this channel. The button will light up in green if the squelch is open. This helps identifying which channels are active in a multi-channel configuration.
|
||||
Use this button to toggle audio mute for this channel. The button will light up in green if the squelch is open. This helps identifying which channels are active in a multi-channel configuration.
|
||||
|
||||
<h3>14: UDP output</h3>
|
||||
|
||||
Copies audio output to UDP. Audio is set at fixed level and is muted by the mute button (13) and squelch is also applied. Output is mono S16LE samples. Note that fixed volume apart this is the exact same audio that is sent to the audio device in particular it is highpass filtered at 300 Hz and thus is not suitable for digital communications. For this purpose you have to use the UDP source plugin instead.
|
||||
|
||||
UDP address and send port are specified in the basic channel settings. See: [here](https://github.com/f4exb/sdrangel/blob/master/sdrbase/readme.md#6-channels)
|
||||
@ -228,6 +228,100 @@ This area shows the control GUIs of the channels curently active for the device.
|
||||
|
||||
Details about the GUIs can be found in the channel plugins documentation which consits of a readme.md file in each of the channel plugins folder (done partially).
|
||||
|
||||
With these channels: AM demod, BFM demod, DSD demod, NFM demod, UDP source, UDP sink 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:
|
||||
|
||||
|
||||
|
||||
<h4>6.1: Window title</h4>
|
||||
|
||||
Changes the channel window title
|
||||
|
||||
<h4>6.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>6.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>6.4,5,6: UDP address (4) receive port (5) and send port (6)</h4>
|
||||
|
||||
Some channels can exchange data over UDP. Depending on the channel the data is the following:
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>Channel</th>
|
||||
<th>Data sent</th>
|
||||
<th>Type</th>
|
||||
<th>Data received</th>
|
||||
<th>Type</th>
|
||||
<th>Address</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>AM demod</td>
|
||||
<td>Audio</td>
|
||||
<td>Mono</td>
|
||||
<td>N/A</td>
|
||||
<td>N/A</td>
|
||||
<td>Remote</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>BFM demod</td>
|
||||
<td>Audio</td>
|
||||
<td>Stereo</td>
|
||||
<td>N/A</td>
|
||||
<td>N/A</td>
|
||||
<td>Remote</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>DSD demod</td>
|
||||
<td>Audio</td>
|
||||
<td>Stereo</td>
|
||||
<td>N/A</td>
|
||||
<td>N/A</td>
|
||||
<td>Remote</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>NFM demod</td>
|
||||
<td>Audio</td>
|
||||
<td>Mono</td>
|
||||
<td>N/A</td>
|
||||
<td>N/A</td>
|
||||
<td>Remote</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>UDP source</td>
|
||||
<td>Audio, I/Q</td>
|
||||
<td>Mono, Stereo</td>
|
||||
<td>Audio</td>
|
||||
<td>Mono</td>
|
||||
<td>Remote</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>UDP sink</td>
|
||||
<td>N/A</td>
|
||||
<td>N/A</td>
|
||||
<td>Audio, I/Q</td>
|
||||
<td>Mono, Stereo</td>
|
||||
<td>Local</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Data type is S16LE 1 channel (Mono) or 2 channels (Stereo or I/Q)
|
||||
|
||||
<h4>6.7: Validate and exit dialog</h4>
|
||||
|
||||
Validates the data (saves it in the channel marker object) and exits the dialog
|
||||
|
||||
<h4>6.8: Cancel changes and exit dialog</h4>
|
||||
|
||||
Do not make any changes and exit dialog
|
||||
|
||||
<h3>7. Spectrum from device</h3>
|
||||
|
||||
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)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user