diff --git a/doc/img/MainWindow_channel_01.png b/doc/img/MainWindow_channel_01.png new file mode 100644 index 000000000..28f4f68b3 Binary files /dev/null and b/doc/img/MainWindow_channel_01.png differ diff --git a/doc/img/MainWindow_channel_01.xcf b/doc/img/MainWindow_channel_01.xcf new file mode 100644 index 000000000..2b52c2153 Binary files /dev/null and b/doc/img/MainWindow_channel_01.xcf differ diff --git a/doc/img/MainWindow_channel_02.png b/doc/img/MainWindow_channel_02.png new file mode 100644 index 000000000..fac110f4b Binary files /dev/null and b/doc/img/MainWindow_channel_02.png differ diff --git a/sdrgui/readme.md b/sdrgui/readme.md index 55a8c72ec..9b9a155a7 100644 --- a/sdrgui/readme.md +++ b/sdrgui/readme.md @@ -673,19 +673,23 @@ This area shows the control GUIs of the channels currently active for the device Details about the GUIs can be found in the channel plugins documentation which consists of a readme.md file in each of the channel plugins folder (done partially). +

6.1. Basic channel settings

+ +![Channel control 01](../doc/img/MainWindow_channel_01.png) + With most channel types some common basic settings can be set with a popup dialog. This dialog is opened by clicking on the small grey square on the top left of the channel window. The settings are as follows: ![Basic channel settings](../doc/img/BasicChannelSettings.png) -

6.1: Window title

+
6.1.1: Window title
Changes the channel window title -

6.2: Channel color

+
6.1.2: Channel color
Changes the color of the window title bar and spectrum overlay. To change the color click on the color square to open a color chooser dialog. The hex rgb value is displayed next to the color square. -

6.3: Frequency scale display type

+
6.1.3: Frequency scale display type
When the mouse is over the channel window or over the central line in the spectrum a channel parameter is displayed on the frequency scale. This parameter can be: @@ -694,7 +698,7 @@ When the mouse is over the channel window or over the central line in the spectr - AdSnd: UDP address and send port - AdRcv: UDP address and receive port -

6.4: Toggle reverse API feature

+
6.1.4: Toggle reverse API feature
Use this checkbox to toggle on/off the reverse API feature. With reverse API engaged the changes in the channel settings are forwarded to an API endpoint given by address (6.5), port (6.6), device index (6.7) and channel index (6.8) in the same format as the SDRangel REST API channel settings endpoint. With the values of the screenshot the API URL is: `http://127.0.0.1:8888/sdrangel/deviceset/0/channel/0/settings` The JSON payload follows the same format as the SDRangel REST API channel settings. Using the same example this would be: @@ -727,30 +731,38 @@ Note that the PATCH method is used. The full set of parameters is sent only when More details on this feature can be found on the corresponding Wiki page. -

6.5: API address

+
6.1.5: API address
This is the IP address of the API endpoint -

6.6: API port

+
6.1.6: API port
This is the IP port of the API endpoint -

6.7: Device index

+
6.1.7: Device index
This is the targeted device index -

6.8: Channel index

+
6.1.8: Channel index
This is the targeted channel index -

6.9: Cancel changes and exit dialog

+
6.1.9: Cancel changes and exit dialog
Do not make any changes and exit dialog -

6.10: Validate and exit dialog

+
6.1.10: Validate and exit dialog
Validates the data (saves it in the channel marker object) and exits the dialog +

6.2 Device stream assignment

+ +![Channel control 02](../doc/img/MainWindow_channel_02.png) + +The bigger square next to the leftmost "c" square is the device stream assignment control. With single Rx (source device set) and single Tx devices (sink device set) this is inactive because the channel is simply connected to the single stream as shown by the "S" letter. + +This is in place for future MIMO devices and channels support (v.5). +

7. Spectrum from device

This shows the spectrum in the passband returned from the sampling device possibly after decimation. The actual sample rate is shown in the device control at the left of the frequency display (2.3)