VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-29 11:18:56 -05:00
Code Issues Projects Releases Wiki Activity

Updated documentation (2)

Browse Source
This commit is contained in:
f4exb 2017-08-27 17:20:35 +02:00
parent 4d36cba7a8
commit 59c43310fe
2 changed files with 37 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/img/UDPsrc_plugin.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 67 KiB

80
plugins/channelrx/udpsrc/readme.md
View File

@ -26,7 +26,17 @@ Total power in dB relative to a +/- 1.0 amplitude signal received in the pass ba
Total power in dB relative to a +/- 1.0 amplitude signal sent over UDP.
<h3>4: Type of samples</h3>
<h3>4: UDP address and ports</h3>
These parameters are set with the basic channel settings dialog. See: [here](https://github.com/f4exb/sdrangel/blob/master/sdrbase/readme.md#6-channels)
The display is in the format `address:audio port/data port`
<h3>5: Signal sample rate</h3>
Sample rate in samples per second of the signal that is sent over UDP. The actual byte rate depends on the type of sample which corresponds to a number of bytes per sample.
<h3>6: Type of samples</h3>
Combo box to specify the type of samples that are sent over UDP.
@ -41,27 +51,31 @@ Combo box to specify the type of samples that are sent over UDP.
- `S16LE AM !DC Mono`: Same as above but with a DC block based on magnitude average over a 5 ms period
- `S16LE AM BPF Mono`: Same as AM Mono but raw magnitude signal is passed through a bandpass filter with lower cutoff at 300 Hz and higher cutoff at RF bandwidth frequency
<h3>5: Signal sample rate</h3>
Sample rate in samples per second of the signal that is sent over UDP. The actual byte rate depends on the type of sample which corresponds to a number of bytes per sample.
<h3>6: Remote IP address</h3>
IP address of the remote destination to which samples are sent
<h3>7: Signal bandwidth</h3>
The signal is bandpass filtered to this bandwidth (zero frequency centered) before being sent out as raw I/Q samples or before being demodulated for SSB and FM outputs. Thus a 20000 Hz bandwidth for example means +/-10000 Hz around center channel frequency.
When SSB formats are used only the lower half (LSB) or upper half (USB) of the bandwidth is used. Thus to pass SSB over 3000 Hz bandwidth one should set this signal bandwidth to 6000 Hz.
<h3>8: Remote data port</h3>
<h3>8: FM deviation</h3>
Remote UDP port number to which samples are sent
This is the maximum expected FM deviation in Hz for NFM demodulated samples. Therefore it is active only for `NFM` types of sample formats. A positive deviation of this amount from the central carrier will result in a sample output value of 32767 (0x7FFF) corresponding to a +1.0 real value. A negative deviation of this amount from the central carrier will result in a sample output value of -32768 (0x8000) corresponding to a -1.0 real value.
<h3>9: Local audio UDP port</h3>
<h3>9: AGC and audio feedback control</h3>
There is a possible feedback of audio samples at 48 kHz into SDRangel using this port as the UDP port on the local machine to collect the audio samples.
![UDP Source plugin GUI AGC](../../../doc/img/UDPsrc_plugin_agc.png)
<h4>9.1: Toggle AGC</h4>
It is effective only for AM and SSB. Signal is normalized to +/- 0.5 times the maximum amplitude with a time constant (averaging) of 200 ms. When engaged the squelch gate is fixed at 50 ms. The release time controlled by (15.3) can be increased from the 50 ms default for SSB signals to prevent accidental signal drops due to drops in the voice.
<h4>9.2: Toggle audio feedback</h4>
This turns on or off the audio samples feedback
<h4>9.3: Mono/Stereo toggle for audio feedback</h4>
This toggles between mono or stereo audio feedback
<h3>10: Apply (validation) button</h3>
@ -77,53 +91,33 @@ The changes in the following items only become effective when this button is pre
When any item of these items is changed the button is lit in green until it is pressed.
<h3>11: FM deviation</h3>
This is the maximum expected FM deviation in Hz for NFM demodulated samples. Therefore it is active only for `NFM` types of sample formats. A positive deviation of this amount from the central carrier will result in a sample output value of 32767 (0x7FFF) corresponding to a +1.0 real value. A negative deviation of this amount from the central carrier will result in a sample output value of -32768 (0x8000) corresponding to a -1.0 real value.
<h3>12: AGC and audio feedback control</h3>
![UDP Source plugin GUI AGC](../../../doc/img/UDPsrc_plugin_agc.png)
<h4>12.1: Toggle AGC</h4>
It is effective only for AM and SSB. Signal is normalized to +/- 0.5 times the maximum amplitude with a time constant (averaging) of 200 ms. When engaged the squelch gate is fixed at 50 ms. The release time controlled by (15.3) can be increased from the 50 ms default for SSB signals to prevent accidental signal drops due to drops in the voice.
<h4>12.2: Toggle audio feedback</h4>
This turns on or off the audio samples feedback
<h4>12.3: Mono/Stereo toggle for audio feedback</h4>
This toggles between mono or stereo audio feedback
<h3>13: Gain</h3>
This gain is applied to the samples just before they are sent via UDP. The gain value appears at the right of the slider.
<h3>14: Audio volume</h3>
<h3>11: Audio volume</h3>
Volume of the audio feedback (when se with button 12.2).
<h3>15: Squelch</h3>
<h3>12: Gain</h3>
This gain is applied to the samples just before they are sent via UDP. The gain value appears at the right of the slider.
<h3>13: Squelch</h3>
![UDP Source plugin GUI Squelch](../../../doc/img/UDPsrc_plugin_sq.png)
<h4>15.1: Squelch indicator</h4>
<h4>13.1: Squelch indicator</h4>
The background of the "Sq" text is lit in green when the squelch is open
<h4>15.2: Squelch level</h4>
<h4>13.2: Squelch level</h4>
Use the slider to set the squelch power threshold based on channel input power (2). At the right of the slider the value in dB is displayed
<h4>15.2: Squelch gate</h4>
<h4>13.2: Squelch gate</h4>
Sets the delay after which a signal constantly above the squelch threshold effectively opens the squelch. The same delay is used for squelch release except for SSB where the gate is fixed at 50 ms and this controls the release time only.
The delay in milliseconds is displayed at the right of the button.
<h3>16: Spectrum display</h3>
<h3>14: Spectrum display</h3>
This is the spectrum display of the channel signal after bandpass filtering. Please refer to the Spectrum display description for details.