An open API service indexing awesome lists of open source software.

https://github.com/eartoearoak/sdrsharp-net-remote

A network remote control plugin for SDRSharp.
https://github.com/eartoearoak/sdrsharp-net-remote

remote-control rtl-sdr sdr

Last synced: 5 months ago
JSON representation

A network remote control plugin for SDRSharp.

Awesome Lists containing this project

README

          

# SDRSharp Net Remote #

Copyright 2014 - 2015 Al Brown

al [at] eartoearoak.com

A network and serial remote control plugin for SDRSharp.

More details can be found [here](http://eartoearoak.com/software/sdrsharp-net-remote).

Tested on:

- Windows XP
- Windows 7
- Windows 8.1

## Installation ##
Run the installer and point it to an installation of SDRSharp, this will copy the necessary files and register the plugin.

## Testing ##
Start SDRSharp and check the plugin control panel is shown on the left side of the main window and 'Network' is ticked.

Run:

telnet localhost 3382

You should get a JSON response showing the plugin name and version, for example:

{"Name":"Net Remote","Version":"1.0.5282.28765"}

If 'Serial' is enabled in the control panel commands will be read from the serial port, currently the port defaults to 115200 8N1.

## Commands ##
Commands are JSON formatted strings containing a *Command*, *Method* and optional *Value* attributes. For example to set the current volume to 30:

{"Command": "Set", "Method": "AudioGain", "Value": 30}

Or to test if SDRSharp is currently playing:

{"Command": "Get", "Method": "IsPlaying"}

Which returns:

{"IsPlaying":true}

All attributes are case insensitive.

### Command Attribute ###
The command attribute may be one of the following:

Set
Get
Exe

The value attribute only used with the Set command.

### Method Attribute ###
For the *Get* and *Set* commands the method can be one of the following:

AudioGain - Volume <25-60>
AudioIsMuted - Mute

CenterFrequency - Centre displayed frequency <0-999999999999>
Frequency - Tuned frequency <0-999999999999>

DetectorType - Demodulation

IsPlaying - Currently playing

SourceIsTunable - Tunable device

SquelchEnabled - Squelch
SquelchThreshold - Squelch level <0-100>

FmStereo - FM stereo

FilterType - Filter type <1-6>
FilterBandwidth - Filter bandwidth <10-250000>
FilterOrder - Filter order <10-9999>

For the *Exe* command these methods are available:

Start - Start playing
Stop - Stop playing
Close - Close network connection

### Response ###
The response of a command my be either be *OK* or *Error*.

*OK* is returned if a *Set* command completes:

{"Result":"OK"}

For *Get* commands *method* and *value* attributes are added, e.g.:

{"Result":"OK","Method":"AudioGain","Value":30}

An *Error* is returned if a problem occurred, e.g.:

{"Result":"Error","Type":"Value error","Message":"Value missing"}

## Physical Controls ##
You can use this to interface real-world controls such as buttons and rotary encoders to SDR#, a [basic tutorial](http://eartoearoak.com/tutorials-and-examples/sdrsharp-physical-controls) is available.

## License ##
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see .