mirror of https://github.com/f4exb/sdrangel.git synced 2024-12-24 10:50:29 -05:00

History

Jon Beniston 97496ae9f9 Install debug symbols on Windows for debug builds		2022-02-06 12:56:58 +00:00
..
CMakeLists.txt	Install debug symbols on Windows for debug builds	2022-02-06 12:56:58 +00:00
readme.md	RigCtl Server: added plugin	2020-09-28 19:37:40 +02:00
rigctlserver.cpp	Make rollup state a serializable object so that it can be dumped in JSON format for the API. Prerequisite tp #1050	2022-01-09 05:27:12 +01:00
rigctlserver.h	API: report running state for feature plugins with run action	2021-10-23 21:24:25 +02:00
rigctlservergui.cpp	Make rollup state a serializable object so that it can be dumped in JSON format for the API. Prerequisite tp #1050	2022-01-09 05:27:12 +01:00
rigctlservergui.h	Make rollup state a serializable object so that it can be dumped in JSON format for the API. Prerequisite tp #1050	2022-01-09 05:27:12 +01:00
rigctlservergui.ui	RigCtl Server: added plugin	2020-09-28 19:37:40 +02:00
rigctlserverplugin.cpp	Make rollup state a serializable object so that it can be dumped in JSON format for the API. Prerequisite tp #1050	2022-01-09 05:27:12 +01:00
rigctlserverplugin.h	Removed dangling PluginInstanceGUI references	2020-10-05 16:30:24 +02:00
rigctlserversettings.cpp	Make rollup state a serializable object so that it can be dumped in JSON format for the API. Prerequisite tp #1050	2022-01-09 05:27:12 +01:00
rigctlserversettings.h	Make rollup state a serializable object so that it can be dumped in JSON format for the API. Prerequisite tp #1050	2022-01-09 05:27:12 +01:00
rigctlserverwebapiadapter.cpp	Fix cut and paste errors from PTT feature	2021-01-15 11:00:03 +00:00
rigctlserverwebapiadapter.h	RigCtl Server: added plugin	2020-09-28 19:37:40 +02:00
rigctlserverworker.cpp	Fixed -Wunused-variable warnings	2020-11-14 18:45:05 +01:00
rigctlserverworker.h	Move Feature workers to thread	2021-11-25 09:28:59 +00:00

readme.md

RigCtl server plugin

Introduction

The rigctl server plugin allows SDRangel to be controlled via Hamlib's rigctld protocol. This allows other software that implements the rigctld protocol, such at the satellite tracking software GPredict, to control SDRangel, to adjust for doppler or to automatically switch between different satellite frequencies and modes.

Interface

1: Start/Stop plugin

This button starts or stops the plugin

2: Enable rigctrl server

Checking this option will enable the rigctrl server in SDRangel. The default is disabled.

3: Refresh list of devices and channels

Use this button to refresh the list of devices (4) and channels (5)

4: Select device set

Specify the SDRangel device set that will be controlled by received rigctl commands. Defaults to R0.

5: Select channel

The channel index specifies the SDRangel channel that will be controlled by received rigctl commands. Defaults to 0.

6: Port

The rigctl server plugin opens a TCP port to receive commands from a rigctl client. Please specify a free TCP port number. The default rigctld port is 4532.

7: Max Frequency Offset in Hz

The maximum frequency offset controls whether the center frequency or frequency offset is adjusted when a new frequency is received by a rigctl command. If the difference between the new frequency and the current center frequency is less than this value, the input offset (in the demodulator) will be adjusted. If the difference is greater than this value, the center frequency will be set to the received frequency. To only ever set the center frequency, set this value to 0. The default value is 10000.

Supported rigctrl Commands

The following rigctrl commands are supported:

F / set_freq
f / get_freq
M / set_mode
m / get_mode
get_powerstat
set_powerstat

Example rigctrl Session

Run SDRangel and from the Preferences menu select rigctrl. Check "Enable rigctrl server" and press OK.

In a terminal window, run:

telnet localhost 4532
set_mode AM 1000
set_freq 100000000
set_powerstat 1