Skip to main content

HamLib Configuration Guide

This guide will help you configure Hamlib radio control in Cloudlog Aurora to enable automatic frequency and mode tracking, as well as remote radio control from Cloudlog.

What is Hamlib?​

Hamlib (HAM Radio Library) is a collection of libraries and utilities that provide a standardized interface to control amateur radio transceivers. Cloudlog Aurora uses Hamlib's rigctl utility to communicate with your radio via its CAT (Computer Aided Transceiver) interface.

What you can do with Hamlib in Cloudlog Aurora:

  • Automatically track frequency and mode changes
  • Send frequency/mode to Cloudlog in real-time
  • Remote radio control from Cloudlog web interface
  • Synchronize frequency with FLDigi (optional)
  • Support for multiple radios simultaneously

Prerequisites​

Before configuring Hamlib, ensure you have:

  1. A supported radio with CAT control capability
  2. CAT interface connection:
    • USB cable (most modern radios)
    • Serial (RS-232) cable with USB adapter
    • Network connection (for some newer radios)
  3. Radio's CAT driver installed (if required)
  4. Cloudlog account with API access configured

Installing Hamlib​

Step 1: Download Hamlib​

  1. Visit the official Hamlib downloads page:

  2. Download the appropriate package:

    • For 64-bit Windows: hamlib-w64-x.x.x.zip
    • For 32-bit Windows: hamlib-w32-x.x.x.zip

Step 2: Extract Hamlib​

  1. Extract the downloaded ZIP file to a permanent location

    • Recommended: C:\Ham Radio\Hamlib\
    • Important: Do not extract to a temporary folder or Downloads

  2. Inside the extracted folder, locate the bin directory

    • The rigctl.exe file should be in this folder
    • Example path: C:\Ham Radio\Hamlib\bin\rigctl.exe

Step 3: Note the Path​

Write down or copy the full path to rigctl.exe - you'll need this for Cloudlog Aurora configuration.

Example paths:

  • C:\Ham Radio\Hamlib\bin\rigctl.exe

Finding Your Radio Model Number​

Hamlib identifies each radio by a numeric model ID. You need to find your radio's ID number.

Method 1: Using the Hamlib Website​

  1. Visit Hamlib Supported Radios
  2. Search for your radio manufacturer and model
  3. Note the Model ID number (example: Yaesu FT-991A = 1035)

Method 2: Using rigctl Command​

  1. Open Command Prompt (Windows Key + R, type cmd, press Enter)
  2. Navigate to the Hamlib bin directory:
    cd "C:\Ham Radio\Hamlib\bin"
  3. List all supported radios:
    rigctl.exe --list
  4. Search the output for your radio manufacturer and model
  5. The number before the radio name is the Model ID

Method 3: Common Radio Model IDs​

Here are some popular radios and their Hamlib Model IDs:

ManufacturerModelHamlib ID
Yaesu
FT-991A1035
FT-8911041
FT-817120
FT-8181049
FT-897122
FT-857121
FT-9501019
FTDX-101045
FTDX-101D/MP1043
Icom
IC-7053085
IC-73003073
IC-76103081
IC-97003076
IC-71003070
Kenwood
TS-20002014
TS-590S/SG2033
TS-890S2042
Elecraft
K3/K3S2029
KX32043
Xiegu
G903085
X61001044
Dummy Rig
(for testing)1

Note: Model IDs can change between Hamlib versions. Always verify using rigctl --list with your installed version.

Configuring Cloudlog Aurora​

Step 1: Open Settings​

  1. Launch Cloudlog Aurora
  2. Click File → Settings from the menu

Step 2: Configure Hamlib Path​

  1. In the Settings window, locate the Hamlib section
  2. Click the Browse button next to "rigctl Path"
  3. Navigate to and select rigctl.exe (e.g., C:\Ham Radio\Hamlib\bin\rigctl.exe)
  4. The path should now appear in the text box

Step 3: Enable Radio Control​

  1. Check the box "Enable Radio Control"
  2. Click Save to apply the settings

Step 4: Configure COM Port (If Applicable)​

If your radio uses a serial/USB CAT connection:

  1. Identify your radio's COM port:

    • Open Device Manager (Windows Key + X → Device Manager)
    • Expand Ports (COM & LPT)
    • Look for your radio or USB-to-Serial adapter
    • Note the COM port number (e.g., COM3, COM5, etc.)

  2. Note the baud rate from your radio's manual

    • Common baud rates: 4800, 9600, 19200, 38400, 57600, 115200
    • Example: Yaesu FT-991A uses 38400

Adding Radios​

Once Hamlib is configured, you can add radios to monitor and control.

Step 1: Open Radio Settings​

  1. In Cloudlog Aurora, click Radio → Radio Settings from the menu
  2. The Radio Configuration window will open

Step 2: Configure Your First Radio​

Fill in the following fields:

  1. Custom Radio Name:

    • Enter a unique, descriptive name for this radio configuration
    • Important: This name must be unique within Cloudlog Aurora but does not need to match any Cloudlog station settings
    • Example: Main Shack Radio, Mobile Rig, Portable Station

  2. Hamlib Radio ID:

    • Enter the model number you found earlier
    • Example: 1035 for Yaesu FT-991A
    • Example: 3073 for Icom IC-7300
    • Example: 1 for testing with Dummy Rig

  3. Com Port:

    • Enter the COM port from Device Manager
    • Example: COM3, COM5
    • Format: Always use uppercase COM followed by the number

  4. Baud Rate:

    • Enter the baud rate from your radio's manual
    • Example: 38400, 9600, 115200
    • Must match your radio's CAT settings

  5. Enable FLDigi Integration (Optional):

    • Check this box if you want to synchronize with FLDigi
    • Cloudlog Aurora will send frequency changes to FLDigi
    • FLDigi must be running with XML-RPC enabled (port 7362)

Step 3: Save and Test​

  1. Click Add Radio to save the configuration
  2. The radio will appear in the list
  3. Click Close to return to the main window

Step 4: Verify in Main Window​

  1. In the main Cloudlog Aurora window, locate the Radio List section

  2. Your radio should appear with:

    • A checkbox to enable/disable polling
    • Radio name
    • Current frequency
    • Current mode

  3. The checkbox should be checked by default (polling enabled)

Adding Multiple Radios​

Repeat the above steps for each radio you want to monitor. Cloudlog Aurora supports multiple radios simultaneously, each with independent polling settings.

Example Multi-Radio Setup:

Radio 1: Main Station (IC-7300, COM3, 19200 baud, 500ms poll)
Radio 2: Mobile Rig (FT-991A, COM5, 38400 baud, 1000ms poll)
Radio 3: Remote Station (TS-890S, COM7, 57600 baud, 500ms poll)

Testing Your Configuration​

Basic Connection Test​

  1. Turn on your radio and ensure CAT control is enabled
  2. Verify the radio appears in Device Manager (COM port is active)
  3. Check Cloudlog Aurora's Radio List:
    • Frequency should update when you change your radio's frequency
    • Mode should update when you change your radio's mode

Manual Test with rigctl​

If automatic polling isn't working, test rigctl manually:

  1. Open Command Prompt

  2. Navigate to Hamlib bin directory:

    cd "C:\Ham Radio\Hamlib\bin"

  3. Test reading frequency:

    rigctl.exe -m 1035 -r COM3 -s 38400 f
    • Replace 1035 with your radio's model ID
    • Replace COM3 with your COM port
    • Replace 38400 with your baud rate
    • Should return the current frequency in Hz

  4. Test reading mode:

    rigctl.exe -m 1035 -r COM3 -s 38400 m
    • Should return the current mode (e.g., USB, LSB, FM)

  5. If these commands work, your setup is correct

Testing Remote Commands (Advanced)​

Once configured, you can test remote radio control from Cloudlog:

  1. Log in to your Cloudlog web interface
  2. Navigate to the station where you configured the radio name
  3. Use Cloudlog's radio control features to:
    • Change frequency
    • Change mode
  4. Commands are queued and executed by Cloudlog Aurora every 1 second

Troubleshooting​

Radio Not Appearing in List​

Possible Causes:

  1. Radio control not enabled in Settings
  2. Radio was added but window wasn't refreshed
  3. Configuration file issue

Solutions:

  • Close and reopen Cloudlog Aurora
  • Check Settings → Enable Radio Control is checked
  • Go to Radio → Radio Settings to verify radio was saved

Frequency Shows "N/A"​

Possible Causes:

  1. COM port incorrect or in use by another program
  2. Baud rate doesn't match radio settings
  3. Radio's CAT interface not enabled
  4. Hamlib model ID incorrect
  5. Cable issue

Solutions:

  1. Verify COM port:

    • Check Device Manager for correct port
    • Close other programs using the radio (logging software, SDR, etc.)

  2. Check baud rate:

    • Consult your radio's manual for correct CAT baud rate
    • Some radios allow you to change CAT baud rate in menu settings

  3. Enable CAT on radio:

    • Check your radio's menu for CAT/Computer settings
    • Ensure CAT is enabled and baud rate is set

  4. Verify Hamlib model:

    • Run rigctl --list to confirm model number
    • Try a closely related model if yours isn't working

  5. Check cable:

    • Ensure cable is properly connected
    • Try a different USB port
    • Test with manufacturer's CAT control software

"Unable to open Radio" Error​

Possible Causes:

  1. COM port in use by another application
  2. COM port doesn't exist
  3. Insufficient permissions

Solutions:

  1. Close other programs that might be using the COM port:

    • Other logging software
    • SDR software
    • Manufacturer's control software

  2. Verify COM port in Device Manager:

    • If COM port has a yellow warning icon, update drivers
    • Reconnect USB cable if COM port disappeared

  3. Run Cloudlog Aurora as Administrator (right-click → Run as administrator)

Remote Commands Not Working​

Possible Causes:

  1. Radio name doesn't match Cloudlog station profile
  2. Cloudlog API not configured
  3. Commands are queued but radio is offline

Solutions:

  1. Verify radio name match:

    • In Cloudlog: Settings → Station Profiles → Note exact radio name
    • In Aurora: Radio Settings → Custom Radio Name must match exactly
    • Names are case-sensitive

  2. Check Cloudlog API:

    • Settings → Cloudlog URL must include trailing slash
    • Settings → API Key must be valid

  3. Check Aurora console output:

    • Shows command processing and errors
    • Look for "[RadioCommands]" messages

FLDigi Integration Not Working​

Possible Causes:

  1. FLDigi not running
  2. XML-RPC not enabled in FLDigi
  3. Port conflict

Solutions:

  1. Start FLDigi before enabling integration

  2. Enable XML-RPC in FLDigi:

    • FLDigi menu: Configure → Misc → Web Server
    • Check "Enable XML-RPC Server"
    • Port should be 7362
    • Click Save/Close

  3. Verify port:

    • Default port is 7362
    • Ensure no other program is using this port

Dummy Rig (Model 1) for Testing​

If you want to test without a real radio:

  1. Use Hamlib Model ID: 1
  2. No COM port needed
  3. No baud rate needed
  4. Dummy rig simulates a radio for testing purposes

Configuration Example:

  • Radio Name: Test Radio
  • Hamlib ID: 1
  • COM Port: COM1 (won't be used)
  • Baud Rate: 9600 (won't be used)

Advanced Features​

Multiple Radio Monitoring​

You can monitor multiple radios simultaneously:

  1. Each radio must have a unique COM port
  2. Each radio must have a unique name matching Cloudlog
  3. All radios poll independently at their configured intervals
  4. Enable/disable polling per radio using the checkbox in the main window

Example Multi-Station Setup:

Station A:
  - Radio: Main IC-7300 (COM3)
  - Radio: Secondary FT-991A (COM5)

Station B:
  - Radio: Mobile FT-891 (COM7)

Context Menu Options​

Right-click on any radio in the Radio List to:

  • Enable Polling: Start monitoring frequency/mode
  • Disable Polling: Stop monitoring (saves CPU)
  • Useful for temporarily disabling radios without removing configuration

Configuration File Location​

Radio configurations are stored in:

C:\Users\[YourUsername]\Documents\radiosettings.json

This file contains:

  • Radio names
  • Model IDs
  • COM ports
  • Baud rates
  • Poll times
  • FLDigi settings
  • Polling enabled/disabled state

You can:

  • Edit this file manually (not recommended)
  • Copy it to another computer
  • Back it up for safekeeping

Tips and Best Practices​

1. Match Radio Names Exactly​

  • Radio names in Aurora must exactly match Cloudlog station profile names
  • Case-sensitive: "Main Radio" ≠ "main radio"
  • Spaces matter: "Main Radio" ≠ "MainRadio"

3. Use Descriptive Radio Names​

  • Good: "Shack IC-7300", "Mobile FT-991A", "Portable QRP"
  • Avoid: "Radio1", "Rig", "Test"

4. Test One Radio First​

  • Configure and test one radio before adding multiple
  • Verify frequency/mode updates work
  • Then add additional radios

5. Keep Hamlib Updated​

6. Monitor Console Output​

  • Console shows detailed logging
  • Useful for debugging connection issues
  • Look for error messages

7. Disable Polling When Not Operating​

  • Uncheck radios in Radio List when not in use
  • Saves CPU resources
  • Prevents COM port conflicts with other software