Skip to content

Latest commit

 

History

History
78 lines (61 loc) · 6.72 KB

README.md

File metadata and controls

78 lines (61 loc) · 6.72 KB
Raw

WsjtxUtils

A class library and usage examples related to interacting with WSJT-X through the UDP interface in .NET 8, 7, 6, and .NET Framework 4.8. This library allows for parsing and creating WSJT-X >= 2.2 messages and a lightweight UDP server that supports reading and writing WSJT-X messages utilizing async/await.

Packages

Precompiled packages are available via NuGet.

Package NuGet Stable NuGet Pre-release
WsjtxUtils.WsjtxMessages WsjtxUtils.WsjtxMessages WsjtxUtils.WsjtxMessages
WsjtxUtils.WsjtxUdpServer WsjtxUtils.WsjtxUdpServer WsjtxUtils.WsjtxUdpServer

Table of Contents

WsjtxUtils.WsjtxMessages

The WsjtxMessages library contains the classes and methods needed to serialize and deserialize WSJT-X messages in the QT QDataStream format specified in the WSJT-X source code in NetworkMessage.hpp.

We can easily read messages from a memory source using the extension methods provided.

Memory<byte> source= new(new byte[] { 0xAD, 0xBC, 0xCB, 0xDA, 0x00, 0x00, ... };
WsjtxMessage? message = source.DeserializeWsjtxMessage();

We can write messages to a memory source just as quickly.

Clear message = new("WSJT-X", ClearWindow.BandActivity);

var buffer = GC.AllocateArray<byte>(1500, false);
var numberOfBytesWritten = message.WriteMessageTo(buffer);

WsjtxQsoParser is a utility class attempting to extract as much relevant QSO information from 77-bit modes (FST4, FT4, FT8, MSK144, Q65) WSJT-X Decode messages. The returned WsjtxQso will have the state of the QSO in progress and callsigns, grid square, and report if available.

var qso = WsjtxQsoParser.ParseDecode(decode);
 
var dxCallsign = qso.DXCallsign;
var deCallsign = qso.DECallsign;
var grid = qso.GridSquare;
var report = qso.Report;

WsjtxUtils.WsjtxMessages does not contain a server implementation to allow flexibility and use cases where no server or a custom server is required.

WsjtxUtils.WsjtxUdpServer

WsjtxUdpServer is a lightweight, multicast-capable, asynchronous UDP server for WSJT-X clients. IWsjtxUdpMessageHandler describes an interface that allows WsjtxUdpServer to handle all potential incoming messages from WSJT-X. Create a class that implements IWsjtxUdpMessageHandler and pass this class to the UDP server's constructor to begin processing messages asynchronously.

IWsjtxUdpMessageHandler messageHandler = new SomeCustomMessageHandler();
var cancellationTokenSource = new CancellationTokenSource();

using var server = new WsjtxUdpServer(messageHandler, IPAddress.Any);
server.Start(cancellationTokenSource);

// do other stuff while the server is running and processing messages
while (!cancellationTokenSource.IsCancellationRequested) { }

server.Stop();

WsjtxUdpServerBaseAsyncMessageHandler is an abstract class that implements IWsjtxUdpMessageHandler and provides a basic set of capabilities. It tracks WSJT-X clients and, if available, the last state for each client that has communicated with the server during the previous timeout window, which defaults to 5 minutes. There are properties for connected clients and callbacks used to execute a target function based on specific events, newly connected WSJT-X clients, clients who send the close message, and clients who have not communicated with the server during the previous timeout window.

WsjtxUtils.WsjtxUdpServer.Example.WriteJsonToConsole

An example console application that writes received WSJT-X messages to the console as JSON. WriteMessageToConsoleAsJsonHandler provides an example of receiving and processing WSJT-X messages by implementing the abstract class WsjtxUdpServerBaseAsyncMessageHandler.

The server defaults to the local loopback address and a port of 2237 but can be overridden via command-line arguments.

WsjtxUtils.WsjtxUdpServer.Example.WriteJsonToConsole.exe <Server IP> <Server Port>
WsjtxUtils.WsjtxUdpServer.Example.WriteJsonToConsole.exe 224.0.0.1 2237

WsjtxUtils.WsjtxUdpServer.Example.UpdateGridFromGPS

An example console application that demonstrates using a NEMA GPS device to determine the current maidenhead grid square and sends a Location message to all connected WSJT-X clients. The GPS device defaults to 'COM3' and 9600 baud, while the server defaults to the local loopback address and port 2237 but can be overridden via command-line arguments.

NOTE: Enable the AutoGrid option in WSJT-X settings within Station Details to allow for the reception of Location UDP messages.

WsjtxUtils.WsjtxUdpServer.Example.UpdateGridFromGPS.exe <GPS COM> <GPS Baudrate> <Server IP> <Server Port>
WsjtxUtils.WsjtxUdpServer.Example.UpdateGridFromGPS.exe COM29 9600 224.0.0.1 2237