DOCUMENTATION · VERSION 1.5.18
Set it up,
step by step.
Installation, the GUI, RUN mode, the telnet cluster, N1MM+ and the RBN Aggregator. The same guide, with more detail and the full list of settings, is available as a PDF.
1. What you get
VKVSkimmer is distributed as two independent Windows programs: VKVSkimmer_CW.exe and VKVSkimmer_RTTY.exe. Each has its own decoder chain, its own INI file and its own ports, and you can run one or both. The browser GUI, the telnet cluster and the integrations are the same, so everything in this guide applies to both.
| CW skimmer | RTTY skimmer | |
|---|---|---|
| Program | VKVSkimmer_CW.exe | VKVSkimmer_RTTY.exe |
| Start with logs (optional) | VKVSkimmer_CW_with_logs.bat | VKVSkimmer_RTTY_with_logs.bat |
| Settings file | skimmer.ini | rtty.ini |
| Browser GUI | http://127.0.0.1:8073/ | http://127.0.0.1:8074/ |
| Telnet cluster (spots) | port 7300 | port 7301 |
| Telnet HEARD stream | port 7310 | port 7311 |
| RBN Aggregator port | off (rbn_port = 0) | off (rbn_port = 0) |
The GUI opens by itself in your default browser when the program starts. Public releases are free: no licence file, no expiry.
2. Installation
- Unzip the whole package into one folder, for example
C:\VKVSkimmer. Keep every file and themodelsfolder next to the programs. - Install the software for your input source (below). Only for the input you use.
- Open
skimmer.ini(CW) and/orrtty.ini(RTTY) and write your callsign:callsign = F5VKV. You can also do it later in the GUI. - Start
VKVSkimmer_CW.exeorVKVSkimmer_RTTY.exe. The GUI opens in the browser. To produce logs (for example to report a problem), startVKVSkimmer_CW_with_logs.batorVKVSkimmer_RTTY_with_logs.batinstead.
Requirements: Windows 64-bit and a modern browser (Edge, Chrome or Firefox). An internet connection is recommended for the daily MASTER.SCP / cty.dat updates and for RBN Reference; the skimmer works without it.
Icom IC-7610 / IC-7760 - direct I/Q
VKVSkimmer reads the I/Q directly from the radio's USB 3 I/Q port, in 64-bit: no 32-bit Icom ExtIO driver, no HDSDR, no virtual audio cables.
- IC-7610: firmware 1.20 or later (needed for the I/Q output).
- From the Icom download page of your radio install the USB I/Q Package for HDSDR: it installs the driver of the [USB 2] I/Q port. HDSDR itself is not needed.
- Connect the radio's [USB 2] port to a USB 3.0 port of the PC with a real USB 3.0 cable.
FTD3XX.dllis included: keep it next to the programs.- CI-V runs over the same USB I/Q interface: the radio's other USB / COM CI-V port stays free for your logger.
SDRplay RSP
- Install the SDRplay Hardware API 3.x for Windows from sdrplay.com. It installs
sdrplay_api.dlland the SDRplay API service, which must be running. - Supported: RSP1, RSP1A, RSP1B, RSP2, RSPdx, RSPduo (single tuner).
- Close SDRuno, SDRconnect or any other program that uses the RSP before starting the skimmer.
RTL-SDR dongle
- Download the RTL-SDR Blog Windows release (
Release.zip) from github.com/rtlsdrblog/rtl-sdr-blog/releases and copyrtl_tcp.exeand the DLL files of itsx64folder next to the programs. The skimmer starts and stops rtl_tcp by itself. - Install the WinUSB driver with Zadig (zadig.akeo.ie): run it as administrator, Options > List All Devices, select Bulk-In, Interface (Interface 0), WinUSB, Replace Driver.
- On HF with an RTL-SDR Blog V3 the skimmer uses direct sampling (Q branch) by itself (
rtl_direct = auto). - Close SDR#, SDR++ or any other program that uses the dongle before starting the skimmer.
Sound card
No extra software: receiver audio of any radio, I/Q from an SDR on a sound card input, or the IF output of an Icom radio (USB audio codec, about 15 kHz).
3. First start: callsign and input source
Open the Settings tab on the right of the GUI. Each block has a badge: live = applied at once; restart = saved to the INI file, applied at the next start.
Your callsign
Settings > Your station > Your callsign (live). It is the spotter of every line (DX de F5VKV-#), the telnet greeting, the RBN Aggregator banner and the RBN login.
Portable calls are accepted with a real operating prefix (F/F5VKV, checked against cty.dat) or a suffix (F5VKV/P).
Input source
Settings > Input source, choose the source, Save input, then restart the program. The line in use now shows what the program is actually using.
| Source | INI value | Notes |
|---|---|---|
| Icom IC-7610 / IC-7760 (direct USB I/Q) | input = icom | Whole I/Q band, CI-V tuning, MAIN/SUB, RUN mode, TX protection |
| Sound card - receiver audio (any radio) | input = sound_audio | Audio of the receiver; set sound_rf_khz to the dial frequency |
| Sound card - I/Q (SDR, I/Q output) | input = sound_iq | I/Q of an SDR on a stereo input |
| Icom IF output (USB audio codec) | input = sound_if | About 15 kHz around the dial |
| RTL-SDR dongle | input = rtlsdr | Through rtl_tcp (RTL-SDR Blog release) |
| SDRplay RSP | input = sdrplay | SDRplay API 3 |
CPU profile (CW)
Settings > Profiles (restart): AUTO (recommended: adapts the decoding effort to the CPU load), LIGHT (older or low-power PCs), MAXIMUM (powerful PCs). The Diagnostics block shows the signal rate, lost data and the analysis time per step: if Lost data is not none, choose LIGHT.
4. The GUI
| Area | What it does |
|---|---|
| Top bar | Your call, input source, decoder mode, I/Q rate, analysis time, number of spots and telnet clients, spot beep, UTC clock |
| Fit / + / - / Whole IQ | Zoom on the analysed segments, zoom in and out, or show the whole I/Q band of the source |
| Segment buttons | Jump to one analysed segment (e.g. 14000-14018) |
| Band / Receiver | Band buttons (the radio follows), MAIN / SUB receiver of the Icom |
| Tune / mode | Frequency of the receiver you listen to and its mode: CW, RTTY, USB, LSB, AM, FM |
| MUTED / vol / pitch / filter | Audio in the browser: mute, volume, CW pitch, filter width; tune radio: a click also moves the radio |
| Show chips | CQ, TEST, UP, QSO: what is drawn on the spectrum. All / Runners: quick filters |
| RUN OFF / ON, window, CALLERS | RUN mode (chapter 5) |
| labels / kept | Full or compact labels; how long a spot stays on screen |
| Waterfall ON, history, floor, range, Pause | Waterfall on/off (off = less CPU in the browser), its length and its colours |
| Spots / Signals / Log | Published spots, every signal being decoded, messages of the program |
| Decoder (bottom) | Real-time decoder of the station you listen to |
Labels: green CQ, orange TEST, violet UP. A grey label with a ? is a call read but not (yet) published: the skimmer is not sure enough. Click a label or a spot to listen to the station (and to tune the radio with tune radio).
Whole I/Q: listen anywhere in the band
Whole IQ shows everything the source delivers (about 1.9 MHz with the Icom). Click any signal to listen to it in the browser, in CW, RTTY, USB, LSB, AM or FM, with the filter width you choose. The decoders keep working on the analysed segments whatever you listen to.
Bands
The analysed ranges are in the [bands] section of the INI file (for example 20m = 14000-14070; several ranges with commas; off = not analysed). Changes from the GUI are applied live. VKVSkimmer_CW_with_logs.bat contest uses the wider [bands.contest] table instead.
5. RUN mode
RUN mode is for when you are running (calling CQ): the skimmer shows the stations that call you around your frequency, a few seconds after they call.
- Tune the radio (MAIN) to your run frequency.
- Click RUN OFF in the Show row: it becomes RUN ON. The RUN window follows the radio.
- Choose UP or DOWN and the window width: 0 = simplex (+/- 500 Hz), up to 15 kHz for split operation.
- The spectrum now shows only the stations calling you (CALLER); the list shows callers and runners (CALLERS+RUN). The CALLERS buttons toggle these views.
- Click a caller: the SUB receiver is tuned to it (dual watch). Your TX frequency on MAIN never moves.
- Double click a caller: the QSO is written to the ADIF file (
VKVSkimmer_CW.adiorVKVSkimmer_RTTY.adi). - Click RUN ON again to leave RUN mode: the previous view is restored.
SUB tuning and the window that follows the radio need the Icom direct I/Q input. With an SDR the click moves the listen frequency inside the I/Q.
6. Telnet cluster
The skimmer is its own DX cluster. Every published spot is sent as a standard line, for example:
DX de F5VKV-#: 14021.1 F5VKV CW 37 dB 25 WPM CQ 1417Z
| Port | CW | RTTY | Content |
|---|---|---|---|
| port | 7300 | 7301 | Spots (filtered by spot_mode, default cq: stations heard calling) |
| heard_port | 7310 | 7311 | Every confirmed call, whatever spot_mode. 0 = off |
With a telnet client
telnet 127.0.0.1 7300
Type your callsign when asked. The Windows telnet client must be enabled (Windows Features > Telnet Client); PuTTY works too (connection type Telnet).
N1MM Logger+
- Open the Telnet window.
- In the Clusters tab add a cluster with address
127.0.0.1and port7300(CW) or7301(RTTY). - Select it and click Connect. The skimmer spots appear in the Telnet window, in the band maps and on the Spectrum Display.
DXLog and other loggers
Add a telnet cluster with host 127.0.0.1 and the same port. From another PC on the network use the IP address of the skimmer PC (the telnet ports accept connections from the network; allow them in the Windows firewall).
7. Spectrum in N1MM+
The skimmer can send the spectrum it already computes (the analysed band, about 50 Hz per point) to the N1MM+ Spectrum Display. N1MM+ does not need to open the radio: no I/Q is shared.
- In the skimmer: Settings > Spectrum output for the logger: switch on Send the spectrum to N1MM+, N1MM+ PC
127.0.0.1, UDP port13064, External Source NameSkimmer, lines per second4. Click Save spectrum output and restart the skimmer. - In N1MM+: open the Spectrum Display window, right click, Settings.
- Spectrum Source: External (WB, Flex, etc); External Source Name: Skimmer (the same name as in the skimmer). OK.
Skimmer RTTY by default: use that name in N1MM+ for the RTTY spectrum. The name in N1MM+ must match the one in the skimmer.8. Sending spots to the RBN (RBN Aggregator)
The RBN Aggregator (free, from reversebeacon.net; it needs Microsoft .NET Framework 4) receives the spots of a skimmer over telnet and forwards them to the Reverse Beacon Network. VKVSkimmer has a dedicated port that behaves like VE3NEA's Skimmer Server, so Aggregator connects to it as usual.
rbn_port, 0 = off) and your locator (operator_grid, 4 or 6 characters). Your callsign must be set too. After changing the port or the locator, restart the skimmer.In the skimmer
- Settings > RBN telnet port (Aggregator): a free port, for example
7302. - Your locator (RBN): your Maidenhead locator, for example
JN33RR. - Your QTH (RBN): optional, written in the banner.
- Restart the skimmer.
In RBN Aggregator: Connections tab
- Primary Skimmer Connection: IP Address
127.0.0.1(or the skimmer PC), Port = the skimmer's RBN port. Password: empty. - Callsign: the name Aggregator uses to log in to the skimmer. The spots always carry the callsign set in VKVSkimmer.
- Click Connect. Tick Should Aggregator connect to the Primary Skimmer automatically to reconnect at every start.
- RBN Connection Status must show Connected to the RBN Server.
Check the traffic: Skimmer Traffic tab
- The banner shows
Skimmer Server v.VKVSkimmer_CW 1.5.18 is operated by ..., F5VKVand your locator. - The
SETT:line shows the validation level and the analysed ranges. - Spot lines with + after the time are sent to the RBN.
- Only stations calling CQ / TEST / UP and beacons are sent; TEST and UP are sent as CQ, as Skimmer Server does (
rbn_comment = cq).
9. RBN Reference (incoming RBN spots)
RBN Reference is the opposite direction: the skimmer reads the RBN spots and uses them to confirm, hold or reject its own candidates. It never creates or corrects a callsign. Enable it with rbn_reference = yes in the INI file; it logs in to the RBN with your callsign. If the RBN cannot be reached, the skimmer works normally on its own evidence.
- A call heard by 2 or more RBN skimmers on the same frequency is published at once.
- A truncated or busted reading, when the RBN strongly confirms a similar call there, is rejected (F5VK when the RBN hears F5VKV).
- A call never heard by the RBN, on a frequency where many skimmers hear another station, is a caller of that station: not published.
- A call without RBN evidence waits up to
rbn_reference_hold_sec(default 5 s), then the local decision applies. - Inside the RUN window of the GUI the calls are not checked against the RBN.
10. Contests
spot_mode(also in the GUI): cq (default: stations heard calling in the last 3 minutes), runner, runner_unknown or all.contests.txtlists the contests and the words they send after CQ (CQ WPX, CQ RDXC...). Download the new copy from vkvskimmer.com and replace the file; nothing is downloaded automatically.calling_words: extra words that mean calling, comma separated.VKVSkimmer_CW_with_logs.bat contest/VKVSkimmer_RTTY_with_logs.bat contest: the wider[bands.contest]ranges.
11. Troubleshooting
| Problem | What to check |
|---|---|
| Stations in the GUI but no spots on telnet | Your callsign (red SET YOUR CALLSIGN warning). spot_mode = cq spots only stations heard calling. |
| Aggregator does not connect | rbn_port not 0, operator_grid set, skimmer restarted, same port in Aggregator, port not used by another program. |
| Logger does not connect | Port 7300 (CW) / 7301 (RTTY); another program on the same port; Windows firewall when the logger is on another PC. |
| Icom: no input | USB I/Q Package installed, IC-7610 firmware 1.20+, [USB 2] on a USB 3.0 port with a USB 3.0 cable, FTD3XX.dll next to the program. |
| RTL-SDR: no input | rtl_tcp.exe and its DLLs next to the program, WinUSB on Interface 0 with Zadig (again after a big Windows update), dongle not used by another program. |
| SDRplay: no input | SDRplay API 3 installed and its service running; SDRuno / SDRconnect closed. |
| Lost data / slow analysis | Settings > Profiles: LIGHT. Laptop on AC power. Waterfall OFF in the browser. |
| GUI does not open | Open http://127.0.0.1:8073/ (CW) or :8074/ (RTTY) by hand; web_open = yes. |
| Some stations are never spotted | By design: if a call, a prefix or the CQ role is uncertain, it is not published. |
Reporting a problem
Write to the address on vkvskimmer.com with your callsign, radio / input, Windows version, UTC time, frequency, the call you expected, and the log ZIP that the _with_logs.bat file writes in the logs folder when the program stops (start the program with that BAT file when you want to report a problem).
SUPPORT THE PROJECT
VKVSkimmer is free. Keep it on the air.
No licence, no subscription. If the skimmer is useful in your shack or in a contest, a coffee on Ko-fi helps cover development, test hardware and hosting.