From 70cf86d68a88a3a87a41fd048c781ae97e25b23d Mon Sep 17 00:00:00 2001 From: srcejon Date: Tue, 8 Oct 2024 19:05:18 +0100 Subject: [PATCH] Update docs. --- plugins/channelrx/remotetcpsink/readme.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/plugins/channelrx/remotetcpsink/readme.md b/plugins/channelrx/remotetcpsink/readme.md index 39fb4b4a7..6057b5937 100644 --- a/plugins/channelrx/remotetcpsink/readme.md +++ b/plugins/channelrx/remotetcpsink/readme.md @@ -86,8 +86,8 @@ TCP port on which the server will listen for connections. Specifies the protocol used for sending IQ samples and metadata to clients: - RTL0: Compatible with rtl_tcp - limited to 8-bit IQ data. -- SDRA: Enhanced version of protocol via TCP Socket. -- SDRA wss: SDRA protocol via a Secure Web Socket instead of a TCP Socket. You should use this with the WebAssembly version of SDRangel. +- SDRangel: Enhanced version of protocol via TCP Socket. +- SDRangel wss: SDRangel protocol via a WebSocket Secure instead of a TCP Socket. You should use this if you wish to allow connections from the WebAssembly version of SDRangel.

14: Display Settings

@@ -131,15 +131,17 @@ Generally it should be fine to use the largest setting, unless the sample rate i

SSL Certificate

Specify an SSL certificate .pem file. This is required to use SDRangel wss protocol. +This file can be generated in the same way as for a web server.

SSL Key

Specify an SSL key .pem file. This is required to use SDRangel wss protocol. +This file can be generated in the same way as for a web server.

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. +Check to list the server in a public directory on https://sdrangel.com. +This will allow other users to find and connect to the server via the [Map Feature](../../feature/map/readme.md).

Address

@@ -151,17 +153,17 @@ port forwarding maps the port numbers. 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. +For information only and will be displayed on the [Map](../../feature/map/readme.md).

Antenna

Optionally enter details of the antenna. -For information only and will be displayed on the Map. +For information only and will be displayed on the [Map](../../feature/map/readme.md).

Location

Optionaly enter the location (Town and Country) of the antenna. -For information only and will be displayed on the Map. +For information only and will be displayed on the [Map](../../feature/map/readme.md). 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. @@ -206,5 +208,5 @@ Displays text messages received from clients.

20: Connection Log

-Displays a the IP addresses and TCP port numbers of clients that have connected, along with when they connected and disconnected +Displays the IP addresses and TCP port numbers of clients that have connected, along with when they connected and disconnected and how long they were connected for.