diff --git a/doc/img/RemoteTCPInput_plugin.png b/doc/img/RemoteTCPInput_plugin.png index e9b320097..5a41c2269 100644 Binary files a/doc/img/RemoteTCPInput_plugin.png and b/doc/img/RemoteTCPInput_plugin.png differ diff --git a/doc/img/RemoteTCPSink.png b/doc/img/RemoteTCPSink.png index 2deb2f157..b22c35824 100644 Binary files a/doc/img/RemoteTCPSink.png and b/doc/img/RemoteTCPSink.png differ diff --git a/doc/img/RemoteTCPSink_settings.png b/doc/img/RemoteTCPSink_settings.png new file mode 100644 index 000000000..491987f0b Binary files /dev/null and b/doc/img/RemoteTCPSink_settings.png differ diff --git a/plugins/channelrx/remotetcpsink/readme.md b/plugins/channelrx/remotetcpsink/readme.md index d8371111d..39fb4b4a7 100644 --- a/plugins/channelrx/remotetcpsink/readme.md +++ b/plugins/channelrx/remotetcpsink/readme.md @@ -93,6 +93,97 @@ Specifies the protocol used for sending IQ samples and metadata to clients: Click to open the Settings Dialog. +![Remote TCP sink Settings Dialog](../../../doc/img/RemoteTCPSink_settings.png) + +

Max Clients

+ +Specify the maximum number of clients than can connect simultaneously. +If additional clients attempt to connect, they will be held in a queue. + +

Time Limit

+ +Specify a time limit in minutes for each client connection. Use 0 for no limit. +After the time limit expires, a client will be disconnected. +They will be allowed to reconnect if the maximum number of clients is not reached. + +

Max Channel Sample Rate

+ +Specify the maximum channel sample rate that can be set. This allows a limit to be set on network bandwidth. + +

IQ only

+ +When checked, only uncompressed IQ samples will be transmitted. This is for compatibilty with client software expecting the RTL0 protcol. +Checking this option will disable support for compression, messaging, device location and direction. + +

Compressor

+ +Specify the compressor to use. This can be FLAC or zlib. + +

Compression Level

+ +Specifies the compression effort level. Higher settings can improve compression, but require more CPU time. + +

Block size

+ +Specify the block size the compressor uses. Larger block sizes improve compression, but add latency. +Generally it should be fine to use the largest setting, unless the sample rate is very low. + +

SSL Certificate

+ +Specify an SSL certificate .pem file. This is required to use SDRangel wss protocol. + +

SSL Key

+ +Specify an SSL key .pem file. This is required to use SDRangel wss protocol. + +

List Server

+ +Check to list the server in a public directory on sdrangel.com. +This will allow other users to find and connect to the server via the Map feature. + +

Address

+ +Public IP address or hostname and port number to access the server. +The port number specified here may differ from (12) if your router's +port forwarding maps the port numbers. + +

Frequency Range

+ +Specify minimum and maximum frequencies that users can expect to receive on. +This will typically depend on the SDR and antenna. +For information only and will be displayed on the Map. + +

Antenna

+ +Optionally enter details of the antenna. +For information only and will be displayed on the Map. + +

Location

+ +Optionaly enter the location (Town and Country) of the antenna. +For information only and will be displayed on the Map. +The position the SDRangel icon will be plotted on the Map will be +taken from the device itself, which for most devices, will default +to the position in Preferences > My Position. + +

Isotropic

+ +Check to indicate the antenna is isotropic (non-directional). +When unchecked, the direction the antenna points in can be specified below. + +

Rotator

+ +Specify a Rotator feature that is controlling the direction of the antenna. +Set to None to manually set the direction the antenna points. + +

Direction

+ +Specify the direction the antenna is pointing, as Azimuth in degrees and Elevation in degrees. + +

IP Blacklist

+ +Specify a list of IP addresses that will be prevented from connecting to the server. +

15: Remote Control

When checked, remote clients will be able to change device settings. When unchecked, client requests to change settings will be ignored.