diff --git a/doc/img/UDPsink_plugin.png b/doc/img/UDPsink_plugin.png index 9fd54c8df..8dfbc5312 100644 Binary files a/doc/img/UDPsink_plugin.png and b/doc/img/UDPsink_plugin.png differ diff --git a/plugins/channeltx/udpsink/readme.md b/plugins/channeltx/udpsink/readme.md index 0d25c53e9..d26a92def 100644 --- a/plugins/channeltx/udpsink/readme.md +++ b/plugins/channeltx/udpsink/readme.md @@ -28,7 +28,17 @@ Total power in dB relative to a +/- 1.0 amplitude signal sent in the channel. Use this button to switch off the RF on the channel. The background of the button lits in green when a signal can be sent. -

5: Type of samples

+

5: UDP address and ports

+ +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` + +

6: Input sample rate

+ +Sample rate in samples per second of the signal that is recveived on UDP. The actual byte rate depends on the type of sample which corresponds to a number of bytes per sample. + +

7: Type of samples

Combo box to specify the type of samples that are received and sent in the channel. @@ -40,19 +50,11 @@ Combo box to specify the type of samples that are received and sent in the chann - `S16LE LSB Mono`: Takes a mono (1 channel) AF signal and produces a LSB modulated signal. - `S16LE USB Mono`: Takes a mono (1 channel) AF signal and produces a USB modulated signal. - `S16LE AM Mono`: Takes a mono (1 channel) AF signal and produces a AM modulated signal. + +

8: Mono/Stereo input

+ +This toggles switches between 1 channel (mono) and 2 channels (stereo) input samples format. -

6: Input sample rate

- -Sample rate in samples per second of the signal that is recveived on UDP. The actual byte rate depends on the type of sample which corresponds to a number of bytes per sample. - -

7: Local IP address

- -IP address of the local interface address that listens to UDP samples - -

8: Local data port

- -UDP port number that listens to samples -

9: Output signal bandwidth

The signal is bandpass filtered to this bandwidth (zero frequency centered) before being sent out in the channel. In SSB modes only half of the filter is used (LSB: lower, USB: upper). Thus to send a signal with 3000 Hz bandwidth a bandwidth of 6000 Hz must be selected. In addition in SSB modes a 300 Hz highpass filter is applied. @@ -89,9 +91,13 @@ The button sets the delay after which a signal constantly above the squelch thre The gain (15) should be adjusted so that the peak amplitude (small red vertical bar) never exceeds 100%. Above 100% the signal is clipper which results in distorsion. -

15: Gain

+

15: Input and output Gains

-This gain is applied to the samples just before they are filtered and sent int the channel. The gain value appears at the right of the slider. +Input ("Gi") and output ("Go") gains are placed next to each other. + +The input gain is applied to samples received from UDP. The gain value appears at the right of the button. + +The output gain is applied to the samples just before they are filtered and sent int the channel. The gain value appears at the right of the button.

16: Input buffer gauge

@@ -105,7 +111,11 @@ The buffer consists in 512 bytes frames so that a normalized UDP block can be pl Resets the read and write pointers at their ideal position that is read at start and write at the middle of the buffer. This may cause occasional mess-up with the modulating signal until the read pointer reaches the middle of the buffer. -

16: Spectrum display

+

18: Automatic R/W balance toggle

+ +This button enables or disables the automatic read / write pointers balance compensation so that they are always about half a buffer apart. The compensation adjust the sample rate around nominal input sample rate and can cause some tone wiggle on very narrowband modulations. Therefore you can switch it off at the expense of a small buffer section overlap or drop. With an input from the DSD demodulator it can be better to switch it off since the input samples flow is discontinuous and the automatic compensation may not have the time to adjust. + +

19: Spectrum display

This is the spectrum display of the channel signal before filtering. Please refer to the Spectrum display description for details.