Application Programming Interface & Sample Source Code

The API allows anyone to write a program to interface with the Radio Control Server.  Interfacing to the Radio Control Server can be done via .NET Remoting calls or via a TELNET (text server) interface.  The source code for the Command-Line Control program CLC.EXE, which uses .NET Remoting, is available to help aid the development of third-party applications and add-ons.

Database Table and Query/View Definitions

If a tool such as MyNeoReport is being used to write reports, it is essential to know the structure of the underlying database.  The structure of the database is detailed in the following two Visio diagrams.

Table or View Name
Description
qryViewEdit Contains all information about all logs including QSL information. It is sorted by date/time so the oldest log is at the top and the newest is at the bottom.
qryVAD_Combined Contains all data from HFCC, ILGRadio, PTSW, EIBI, FCC HF, and any Custom entries in a single view. Sorted
qryCommunity All information about any logs that have been downloaded from the Community.

It is not possible to create a report against What's Playing Now because all of the WPN data is created on-the-fly each time it is called.

Ham Radio Deluxe Compatability & Integration

The IP Server function of the Ham Radio Deluxe (HRD) program was built to support the Digital Master 780 (DM780 ) program; however, the IP Server is just a plain text server, so it can be easily utilized by other applications.

The Radio Control Server provides an interface that emulates many of the features of the IP Server and that includes additional functionality.  The first and obvious thing that can be done with the IP Server is that the DM780 application can run directly against the Radio Control Server and does not require Ham Radio Deluxe to be used.  This allows the DM780 application to be used with any receiver that the Radio Control Server supports, regardless of whether HRD supports the receiver.  Specifically, the AOR7030, Ten-Tec receivers, Lowe Receivers, and many others can now work with the DM780 application.   

Another aspect of this is integration with RemoteHams.com.  RemoteHams.com is an excellent site for publishing your receiver on the Internet.  While the RCSweb application is provided with every copy of Shortwave Log, it does require Microsoft IIS to be run on the local computer.  And getting IIS to work is not always the easiest task.  RemoteHams.com directly integrates with the IP Server emulation that is built-into the Radio Control Server.  In other words, RemoteHams.com will publish any SWLog/RCS receiver on the web with little to no work and without having to use RCSweb!


This IP Server function (also called the text server) supports two modes: RCS Native and HRD Emulation.  RCS Native commands are supported only by this application.  HRDEmulation commands emulated the corresponding functions of the Ham Radio Deluxe IP Server.  This allows for applicationslike DM780 to be used with RCS.


                              RCS Native Commands:
                              --------------------
get chat, returns all chat messages
get chat nn, where nn=number (1-99) of chat messages
get filter
get freq
get frequency
get memories
get mode
get radio
get receiver
get receiver settings
get smeter
get smeter value
get squelch
get uptime
get user activity [nn], where nn=number of seconds and is optional
get welcome message
get version
send chat chat_message
set attenuator [on/off]
set filter filter_name
set freq freq_in_hertz
set frequency freq_in_hertz
set memory memory_number
set mode mode_name
set pass password (This is not compatible with HRD/DM780 emulation.)
set squelch squelch_value [0-255]
bye
exit
quit


                         HRD/DM780 Emulation Commands:
                         -----------------------------
get context (This will always return 1; [c]=[1] for HRD/DM780 emulation.)
[c] get dropdown-list {Dropdown}
[c] get dropdowns
[c] get dropdown-text {Dropdown}
[c] get frequency
[c] get id
[c] get logbookupdates
[c] get radio
[c] get smeter-main
[c] get user-active
[c] set block
[c] set frequency-hz
[c] set unblock

Why Use the API?
This API allows for great flexibilty. A simple, text-based client could be written for the Macintosh or other operating system that would directly control a receiver. Or a programming language like PHP could be used to read the frequency from the radio and display it on a web page. There are many possibilities.