VE7UWU/sdrangel
1
0
Fork 0
mirror of https://github.com/f4exb/sdrangel.git synced 2024-11-21 23:55:13 -05:00
Code Issues Projects Releases Wiki Activity

Remote input and output documentation and GUI changes related to only getting remote information. Fixes #832

Browse Source
This commit is contained in:
f4exb 2021-04-03 07:23:02 +02:00
parent ec4f0dadb0
commit dcae5e29e2
10 changed files with 53 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/img/RemoteInput_plugin.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 34 KiB

BIN
doc/img/RemoteInput_plugin.xcf
View File

Binary file not shown.

BIN
doc/img/RemoteInput_plugin_05.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 5.3 KiB

After

Width:  |  Height:  |  Size: 6.2 KiB

BIN
doc/img/RemoteInput_plugin_05.xcf
View File

Binary file not shown.

BIN
doc/img/RemoteOutput_plugin.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

BIN
doc/img/RemoteOutput_plugin.xcf
View File

Binary file not shown.

44
plugins/samplesink/remoteoutput/readme.md
View File

@ -6,9 +6,9 @@ This output sample sink plugin sends its samples over the network to a SDRangel
Forward Error Correction with a Cauchy MDS block erasure codec is used to prevent block loss. This can make the UDP transmission more robust particularly over WiFi links.
The distant SDRangel instance to which the data stream is sent is controlled via its REST API using a separate control software for example [SDRangelcli](https://github.com/f4exb/sdrangelcli)
The remote SDRangel instance to which the data stream is sent is controlled via its REST API using a separate control software for example [SDRangelcli](https://github.com/f4exb/sdrangelcli)
The sample size used in the I/Q stream is the Rx sample size of the local instance. Possible conversion takes place in the distant Remote source channel plugin to match the Rx sample size of the distant instance. Best performace is obtained when both instances use the same sample size.
The sample size used in the I/Q stream is the Rx sample size of the local instance. Possible conversion takes place in the remote Remote source channel plugin to match the Rx sample size of the remote instance. Best performace is obtained when both instances use the same sample size.
It is present only in Linux binary releases.
@ -22,11 +22,11 @@ The plugin will be built only if the [CM256cc library](https://github.com/f4exb/
<h3>1: Start/Stop</h3>
Device start / stop button.
Device start / stop button.
- Blue triangle icon: device is ready and can be started
- Green square icon: device is running and can be stopped
<h3>2: Stream sample rate</h3>
I/Q sample rate in kS/s of the stream that is sent over the network.
@ -39,7 +39,7 @@ This is the center frequency in kHz of the remote instance device.
This is the remote instance baseband sample rate. It can be a power of two multiple of the stream sample rate (2) but it will not work for other values.
<h3>5: Stream controls and API destination</h3>
<h3>5: Stream controls and API destination</h3>
![SDR Remote output sample rate GUI](../../../doc/img/RemoteOutput_plugin_05.png)
@ -57,8 +57,8 @@ The value is a percentage of the nominal time it takes to process a block of sam
- Delay percentage: _d_
- Number of FEC blocks: _F_
- There are 127 blocks of I/Q data per frame (1 meta block for 128 blocks) and each I/Q data block of 512 bytes (128 samples) has a 8 bytes header (2 samples) thus there are 126 samples remaining effectively. This gives the constant 127*126 = 16002 samples per frame in the formula
Formula: ((127 &#x2715; 126 &#x2715; _d_) / _SR_) / (128 + _F_)
Formula: ((127 &#x2715; 126 &#x2715; _d_) / _SR_) / (128 + _F_)
<h4>5.3: remote instance device set index</h4>
@ -105,33 +105,35 @@ This counter counts the unrecoverable error conditions found (i.e. 6.4 between 1
This HH:mm:ss time display shows the time since the reset events counters button (4.6) was pushed.
<h3>7: Distant transmitter queue length gauge</h3>
<h3>7: Remote transmitter queue length gauge</h3>
This is ratio of the reported number of data frame blocks in the remote queue over the total number of blocks in the queue.
<h3>8: Distant transmitter queue length status</h3>
<h3>8: Remote transmitter queue length status</h3>
This is the detail of the ratio shown in the gauge. Each frame block is a block of 127 &#x2715; 126 samples (16 bit I or Q samples) or 127 &#x2715; 63 samples (24 bit I or Q samples).
<h3>9: Distant server API address and port</h3>
<h3>9: Remote server test</h3>
Test remote connection with its API.
![SDR Remote input stream GUI](../../../doc/img/RemoteInput_plugin_05.png)
<h4>9.1: API connection indicator</h4>
<h4>9.1: Remote connection indicator</h4>
The "API" label is lit in green when the connection is successful
The "Remote" label is lit in green when the connection is successful
<h4>9.2: API IP address</h4>
IP address of the distant SDRangel instance REST API
IP address of the remote SDRangel instance REST API
<h4>9.3: API port</h4>
Port of the distant SDRangel instance REST API
Port of the remote SDRangel instance REST API
<h4>9.4: Validation button</h4>
<h4>9.4: Get information button</h4>
When the return key is hit within the address (9.2) or port (9.3) the changes are effective immediately. You can also use this button to set again these values. Clicking on this button will send a request to the API to get the distant SDRangel instance information that is displayed in the API message box (8)
When the return key is hit within the address (9.2) or port (9.3) the changes are effective immediately. You can also use this button to set again these values. Clicking on this button will send a request to the API to get the remote SDRangel instance information that is displayed in the API message box (8)
<h3>10: Local data address and port</h3>
@ -139,20 +141,20 @@ When the return key is hit within the address (9.2) or port (9.3) the changes ar
<h4>10.1: Data IP address</h4>
IP address of the local network interface the distant SDRangel instance sends the data to
IP address of the local network interface the remote SDRangel instance sends the data to
<h4>10.2: Data port</h4>
Local port the distant SDRangel instance sends the data to
Local port the remote SDRangel instance sends the data to
<h4>10.3: Validation button</h4>
When the return key is hit within the address (10.2) or port (10.3) the changes are effective immediately. You can also use this button to set again these values.
When the return key is hit within the address (10.2) or port (10.3) the changes are effective immediately. You can also use this button to set again these values.
<h3>11: Status message</h3>
The API status is displayed in this box. It shows "API OK" when the connection is successful and reply is OK
<h3>12: API information</h3>
<h3>12: Remote information</h3>
This is the information returned by the API and is the distance SDRangel instance information if transaction is successful
This is the information returned by the remote when connection with its API is successful

14
plugins/samplesink/remoteoutput/remoteoutputgui.ui
View File

@ -599,7 +599,7 @@
<widget class="QLabel" name="apiAddressLabel">
<property name="minimumSize">
<size>
<width>30</width>
<width>50</width>
<height>0</height>
</size>
</property>
@ -607,7 +607,7 @@
<string>Green if communication OK else KO</string>
</property>
<property name="text">
<string>API</string>
<string>Remote</string>
</property>
</widget>
</item>
@ -626,7 +626,7 @@
<string>000.000.000.000</string>
</property>
<property name="text">
<string>0...</string>
<string>0.0.0.0</string>
</property>
</widget>
</item>
@ -678,10 +678,10 @@
</size>
</property>
<property name="toolTip">
<string>Set API address and port</string>
<string>Get remote information</string>
</property>
<property name="text">
<string>Set</string>
<string>Info</string>
</property>
</widget>
</item>
@ -693,7 +693,7 @@
<widget class="QLabel" name="dataAddressLabel">
<property name="minimumSize">
<size>
<width>30</width>
<width>50</width>
<height>0</height>
</size>
</property>
@ -717,7 +717,7 @@
<string>000.000.000.000</string>
</property>
<property name="text">
<string>0...</string>
<string>0.0.0.0</string>
</property>
</widget>
</item>

34
plugins/samplesource/remoteinput/readme.md
View File

@ -8,9 +8,9 @@ Forward Error Correction with a Cauchy MDS block erasure codec is used to preven
Please note that there is no provision for handling out of sync UDP blocks. It is assumed that frames and block numbers always increase with possible blocks missing. Such out of sync situation has never been encountered in practice.
The distant SDRangel instance that sends the data stream is controlled via its REST API using a separate control software for example [SDRangelcli](https://github.com/f4exb/sdrangelcli)
The remote SDRangel instance that sends the data stream is controlled via its REST API using a separate control software for example [SDRangelcli](https://github.com/f4exb/sdrangelcli)
A sample size conversion takes place if the stream sample size sent by the distant instance and the Rx sample size of the local instance do not match (i.e. 16 to 24 bits or 24 to 16 bits). Best performace is obtained when both instances use the same sample size.
A sample size conversion takes place if the stream sample size sent by the remote instance and the Rx sample size of the local instance do not match (i.e. 16 to 24 bits or 24 to 16 bits). Best performace is obtained when both instances use the same sample size.
It is present only in Linux binary releases.
@ -31,7 +31,7 @@ Device start / stop button.
<h3>2: Frequency</h3>
This is the center frequency in Hz sent in the meta data from the distant SDRangel instance and corresponds to the center frequency of reception. The sub kHz value (000 to 999 Hz) is represented in smaller digits on the right.
This is the center frequency in Hz sent in the meta data from the remote SDRangel instance and corresponds to the center frequency of reception. The sub kHz value (000 to 999 Hz) is represented in smaller digits on the right.
<h3>3: Stream sample rate</h3>
@ -80,11 +80,11 @@ The system tries to compensate read / write unbalance however at start or when a
<h4>6.1: Sample size</h4>
This is the size in bits of a I or Q sample sent in the stream by the distant server.
This is the size in bits of a I or Q sample sent in the stream by the remote server.
<h4>6.2: Total number of frames and number of FEC blocks</h4>
This is the total number of frames and number of FEC blocks separated by a slash '/' as sent in the meta data block thus acknowledged by the distant server. When you set the number of FEC blocks with (4.1) the effect may not be immediate and this information can be used to monitor when it gets effectively set in the distant server.
This is the total number of frames and number of FEC blocks separated by a slash '/' as sent in the meta data block thus acknowledged by the remote server. When you set the number of FEC blocks with (4.1) the effect may not be immediate and this information can be used to monitor when it gets effectively set in the remote server.
A frame consists of 128 data blocks (1 meta data block followed by 127 I/Q data blocks) and a variable number of FEC blocks used to protect the UDP transmission with a Cauchy MDS block erasure correction.
@ -124,25 +124,27 @@ This counter counts the unrecoverable error conditions found (i.e. 4.4 between 1
This HH:mm:ss time display shows the time since the reset events counters button (4.6) was pushed.
<h3>7: Distant server API address and port</h3>
<h3>7: Remote server test</h3>
Test remote connection with its API.
![SDR Remote input stream GUI](../../../doc/img/RemoteInput_plugin_05.png)
<h4>7.1: API connection indicator</h4>
<h4>7.1: Remote connection indicator</h4>
The "API" label is lit in green when the connection is successful
The "Remote" label is lit in green when the connection is successful
<h4>7.2: API IP address</h4>
IP address of the distant SDRangel instance REST API
IP address of the remote SDRangel instance REST API
<h4>7.3: API port</h4>
Port of the distant SDRangel instance REST API
Port of the remote SDRangel instance REST API
<h4>7.4: Validation button</h4>
<h4>7.4: Get information button</h4>
When the return key is hit within the address (5.2) or port (5.3) the changes are effective immediately. You can also use this button to set again these values. Clicking on this button will send a request to the API to get the distant SDRangel instance information that is displayed in the API message box (8)
When the return key is hit within the address (5.2) or port (5.3) the changes are effective immediately. You can also use this button to set again these values. Clicking on this button will send a request to the API to get the remote SDRangel instance information that is displayed in the API message box (8)
<h3>8: Local network interface address and port for data reception</h3>
@ -150,11 +152,11 @@ When the return key is hit within the address (5.2) or port (5.3) the changes ar
<h4>8.1: Interface IP address</h4>
IP address of the local network interface the distant SDRangel instance sends the data to. Effective when the validation button (8.3) is pressed.
IP address of the local network interface the remote SDRangel instance sends the data to. Effective when the validation button (8.3) is pressed.
<h4>8.2: Interface port</h4>
Local port the distant SDRangel instance sends the data to. Effective when the validation button (8.3) is pressed.
Local port the remote SDRangel instance sends the data to. Effective when the validation button (8.3) is pressed.
<h4>8.3: Validation button</h4>
@ -172,6 +174,6 @@ This is the address of the multicast group. Effective when the validation button
The API status is displayed in this box. It shows "API OK" when the connection is successful and reply is OK
<h3>12: API information</h3>
<h3>12: Remote information</h3>
This is the information returned by the API and is the distance SDRangel instance information if transaction is successful
This is the information returned by the remote when connection with its API is successful

10
plugins/samplesource/remoteinput/remoteinputgui.ui
View File

@ -587,12 +587,12 @@
<widget class="QLabel" name="apiAddressLabel">
<property name="minimumSize">
<size>
<width>30</width>
<width>50</width>
<height>0</height>
</size>
</property>
<property name="text">
<string>API</string>
<string>Remote</string>
</property>
</widget>
</item>
@ -687,10 +687,10 @@
</size>
</property>
<property name="toolTip">
<string>Set API link</string>
<string>Get remote information</string>
</property>
<property name="text">
<string>Set</string>
<string>Info</string>
</property>
</widget>
</item>
@ -702,7 +702,7 @@
<widget class="QLabel" name="dataAddressLabel">
<property name="minimumSize">
<size>
<width>30</width>
<width>50</width>
<height>0</height>
</size>
</property>