Skip to main content
Documentation for qso-graph-sim v0.3.1. Source at v0.3.1.

qso-graph-sim

PyPI Python License: GPL v3

Replays what a ham radio program sends on the network, from its own log, so you can build and test whatever receives it without a radio, an antenna or the program itself.

We start with WSJT-X. Give it an ALL.TXT, the log WSJT-X keeps of every decode, and it sends those decodes over UDP exactly as WSJT-X does: Heartbeat, Status and Decode messages, one cycle every 15 seconds. Anything that listens to WSJT-X, such as QSO Graph Desktop's Monitor, sees a live band.

It needs nothing but Python and qso-graph-lib, which pip installs with it: no audio and no radio.

Run it​

With uv, run it with nothing installed, as QSO Graph's MCP servers run:

uvx qso-graph-sim --wsjtx --to 192.168.1.50:2237

To use it regularly, install it once. That puts the qg-sim command on your PATH, on Windows, Linux and macOS alike:

uv tool install qso-graph-sim
qg-sim --wsjtx --to 192.168.1.50:2237

qso-graph-sim is installed too, as the same command.

Always name the package with uvx: uvx qso-graph-sim, or uvx --from qso-graph-sim qg-sim. Not uvx qg-sim: uvx would look for a PyPI package called qg-sim, which isn't this one.

To run the newest code instead, see Development.

Quick start​

Point it at the computer and port your receiver listens on. WSJT-X's own default port is 2237.

qg-sim --wsjtx --to 192.168.1.50:2237

With no --file it plays a sample that comes with it: almost two busy minutes of 20 m FT8: 120 decodes in 7 cycles. To play your own log, give it WSJT-X's ALL.TXT:

PlatformWhere WSJT-X keeps ALL.TXT
Windows%LOCALAPPDATA%\WSJT-X\ALL.TXT
Linux~/.local/share/WSJT-X/ALL.TXT
macOS~/Library/Application Support/WSJT-X/ALL.TXT
qg-sim --wsjtx --to 192.168.1.50:2237 --file ALL.TXT --from 260407_233000 --call KI7MT --grid DN13

It stops at the end of the log (or keeps going with --loop), or when you press Ctrl+C. Either way it sends Clear and Close, as WSJT-X does when it shuts down.

What it sends​

Per cycle, in the order WSJT-X sends them:

MessageWhen
Heartbeatevery 15 seconds
Statusas decoding starts and as it ends, with the log's dial frequency and mode, and your --call and --grid
Decodeone per line of the log, stamped with the cycle it is played in, so the band looks live
Clear, Closeon the way out

It also answers Replay, the message a receiver sends to ask for the decodes WSJT-X already has: every decode played so far, marked not new, then a Status. It listens only to the address it was pointed at, and only to messages for its own Id.

The protocol is WSJT-X's own, as described in Network/NetworkMessage.hpp, schema 3, encoded by qso_graph_lib.jt, the same code jt-mcp decodes it with. A Tx line in the log is skipped: these are decodes, not your own transmissions.

Options​

qg-sim --wsjtx --to IP:PORT [--file PATH] [--from YYMMDD_HHMMSS]
[--id NAME] [--call CALL] [--grid GRID] [--speed N] [--loop]
OptionMeaning
--wsjtxthe program to play as. WSJT-X is the first; more follow
--to IP:PORTthe receiver's address. An IP address, not a host name
--file PATHthe log to play; the sample if left out
--from YYMMDD_HHMMSSstart at this time in the log
--id NAMEthe instance name to send as; WSJT-X's default is WSJT-X. Run two with different names to look like two rigs
--call, --gridyour callsign and grid, sent in Status
--speed Nplay N times faster than real time, for automated tests; more than 0, up to 1000
--loopstart again at the end

Testing with WSJT-X itself​

To test with the real program and still no radio, run WSJT-X with Rig: None, then use Help → Download Samples and File → Open to play a recording. WSJT-X decodes it and sends the same messages it sends on the air, marked as off air.

Development​

git clone https://github.com/qso-graph/qso-graph-sim.git
cd qso-graph-sim
uv sync --group dev
uv run pytest

Part of QSO-Graph​

This package is part of qso-graph, tools for amateur radio. See qso-graph.io for documentation.

License​

GPLv3