1
0
mirror of https://github.com/f4exb/sdrangel.git synced 2026-06-08 00:44:48 -04:00

Local Output/Sink: updated documentation

This commit is contained in:
f4exb
2019-05-11 00:42:21 +02:00
parent 8029194c02
commit c69b1421a7
13 changed files with 186 additions and 16 deletions
@@ -0,0 +1,51 @@
#--------------------------------------------------------
#
# Pro file for Windows builds with Qt Creator
#
#--------------------------------------------------------
TEMPLATE = lib
CONFIG += plugin
QT += core gui widgets multimedia network opengl
TARGET = outputlocal
INCLUDEPATH += $$PWD
INCLUDEPATH += ../../../exports
INCLUDEPATH += ../../../sdrbase
INCLUDEPATH += ../../../sdrgui
INCLUDEPATH += ../../../swagger/sdrangel/code/qt5/client
macx:INCLUDEPATH += /opt/local/include
CONFIG(Release):build_subdir = release
CONFIG(Debug):build_subdir = debug
CONFIG(MINGW32):INCLUDEPATH += "C:\softs\boost_1_66_0"
CONFIG(MSVC):INCLUDEPATH += "C:\softs\boost_1_66_0"
CONFIG(macx):INCLUDEPATH += "../../../boost_1_69_0"
SOURCES += localoutputgui.cpp\
localoutput.cpp\
localoutputsettings.cpp\
localoutputplugin.cpp
HEADERS += localoutputgui.h\
localoutput.h\
localoutputsettings.h\
localoutputplugin.h
FORMS += localoutputgui.ui
LIBS += -L../../../sdrbase/$${build_subdir} -lsdrbase
LIBS += -L../../../sdrgui/$${build_subdir} -lsdrgui
LIBS += -L../../../swagger/$${build_subdir} -lswagger
macx {
QMAKE_LFLAGS_SONAME = -Wl,-install_name,@rpath/
}
RESOURCES = ../../../sdrgui/resources/res.qrc
CONFIG(MINGW32):DEFINES += USE_INTERNAL_TIMER=1
@@ -65,20 +65,6 @@
</property>
</widget>
</item>
<item>
<widget class="ButtonSwitch" name="record">
<property name="toolTip">
<string>Toggle record I/Q samples from device</string>
</property>
<property name="text">
<string/>
</property>
<property name="icon">
<iconset resource="../../../sdrgui/resources/res.qrc">
<normaloff>:/record_off.png</normaloff>:/record_off.png</iconset>
</property>
</widget>
</item>
</layout>
</item>
<item>
+24
View File
@@ -0,0 +1,24 @@
<h1>Local output plugin</h1>
<h2>Introduction</h2>
This output sample sink plugin sends its samples to a Local Source channel in another device set.
<h2>Interface</h2>
![SDR Local output plugin GUI](../../../doc/img/LocalOutput_plugin.png)
<h3>1: Start/Stop</h3>
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: Frequency</h3>
This is the center frequency in Hz sent from the Local Source channel instance and corresponds to the center frequency of transmission. The sub kHz value (000 to 999 Hz) is represented in smaller digits on the right.
<h3>3: Stream sample rate</h3>
Stream I/Q sample rate in kS/s