WinKeyer Tools Help

Complete guide to the web-based WK3tools interface

📖Introduction

WinKeyer Tools is a complete web-based implementation of the popular WK3tools application. It provides full control and configuration of your WinKeyer USB device directly from your browser, eliminating the need for separate desktop software.

This web interface communicates with the WinKeyer3 IC (by K1EL) using the Web Serial API, providing the same functionality as the original WK3tools application but accessible from any modern browser.

What is WinKeyer USB?

WinKeyer USB is a popular CW keyer device built around the K1EL WinKeyer3 IC. It connects to your computer via USB, appears as a virtual serial port, and provides accurate Morse code keying with features like memory storage, adjustable speed/timing, and paddle support.

🌐Browser Requirements

The WinKeyer Tools interface requires a browser that supports the Web Serial API:

✅ Supported Browsers

  • Google Chrome (version 89 or later)
  • Microsoft Edge (version 89 or later)
  • Opera (version 75 or later)
  • Other Chromium-based browsers

❌ Not Supported

  • Firefox (Web Serial API not available)
  • Safari (Web Serial API not available)
  • Mobile browsers (technical limitation)
  • Internet Explorer

Note: HTTPS is required for Web Serial API functionality. This website automatically uses HTTPS.

🚀Getting Started

Step 1: Hardware Setup

  1. Connect your WinKeyer USB device to your computer
  2. Ensure Windows recognizes the device (check Device Manager)
  3. Note which COM port is assigned (though the web interface handles this automatically)
  4. Close any other applications that might be using the WinKeyer device

Step 2: Connecting in Web Interface

  1. Open the WinKeyer Tools page in a supported browser
  2. Click "Connect to WinKeyer USB" in the Connection section
  3. Select your WinKeyer device from the browser's port selection dialog
  4. Once connected, the status will show "Connected" with a green indicator
  5. Click "Open Host Mode" to enable full communication

Step 3: Reading Current Settings

When you first connect, the interface shows default values. To load the actual settings from your WinKeyer device:

  1. Click "Read All Settings from WKUSB" in the Settings section
  2. The interface will populate with your device's current configuration
  3. You can now adjust settings and write them back to the device

🔧Interface Sections

🔌 Connection & Status

Manage your device connection and monitor status.

  • Connect/Disconnect: Establish or close the serial connection
  • Host Mode: Enable full communication for sending commands and settings
  • Device Info: Shows port, baud rate, version, and connection status
  • Status Indicator: Green (connected/idle), Orange (busy), Red (error)

📋 Read & Write Settings

Transfer configuration between the web interface and your device.

  • Read All Settings: Load current configuration from WinKeyer EEPROM
  • Write All Settings: Send all current web interface settings to the device
  • Save to EEPROM: Permanently store settings in device memory
  • Reset to Defaults: Restore factory default settings
  • Get Version/Status: Query device information

⚡ Basic Parameters

Essential CW keying settings.

Speed & Timing:
  • WPM Speed: 5-99 words per minute
  • Weighting: Dit/dah ratio (10-90%)
  • Farnsworth: Character spacing speed
Sidetone & PTT:
  • Sidetone Frequency: 300-2000 Hz
  • PTT Lead Time: TX delay before keying
  • PTT Tail Time: TX hold after keying

🔧 Advanced Parameters

Professional keying features and competition settings.

Keyer Mode:
  • Iambic A/B: Standard paddle keying modes
  • Ultimatic: Last paddle pressed takes priority
  • Bug Mode: Straight key emulation
  • Options: Auto space, paddle swap, echo
Competition Features:
  • SO2R: Single operator, two radio support
  • Competition Word Space: Extended spacing
  • Key Compensation: Transmitter delay adjustment
  • Serial Number Speed: Contest number timing

💾 Memory Management

Store and play back CW messages using 12 memory slots.

Memory Operations:
  • Read memory content from device
  • Write new content to memory slots
  • Clear individual memory slots
  • Up to 127 characters per slot
Playback Controls:
  • Quick playback buttons for all 12 slots
  • Stop playback command
  • Memory stacking support
  • Instant access during operation

📤 Send Text & Commands

Send live CW text and manage contest functions.

Text Transmission:
  • Send any text as Morse code
  • Buffer queues text for smooth sending
  • Clear buffer to stop transmission
  • Real-time text-to-CW conversion
Quick Commands:
  • Send callsign with one click
  • Auto-incrementing serial numbers
  • 5-second tuning carrier
  • Instant buffer clear

🖥️ Console & Monitor

Monitor communication and send low-level commands.

Console Features:
  • Real-time communication log
  • Color-coded message types
  • Timestamps for all events
  • Auto-scroll and manual clear
Raw Commands:
  • Send hex or decimal commands
  • Quick buttons for common commands
  • Direct WinKeyer3 protocol access
  • Advanced troubleshooting tools

📝Common Tasks

Setting Up a New WinKeyer

  1. Connect to device and open host mode
  2. Read current settings to see factory defaults
  3. Adjust WPM, sidetone, and basic parameters to your preference
  4. Set your callsign in the Send Text section
  5. Write all settings to device
  6. Save settings to EEPROM for permanent storage

Programming Contest Memories

  1. Select a memory slot (1-12)
  2. Enter your contest message (e.g., "CQ TEST W1ABC W1ABC")
  3. Click "Write Memory" to store the message
  4. Repeat for all needed messages
  5. Use the M1-M12 buttons for instant playback during contests

Contest Operation Setup

  1. Enable competition features in Advanced Parameters
  2. Set appropriate competition word spacing
  3. Configure serial number speed if needed
  4. Program memory slots with standard contest messages
  5. Test all memories before the contest
  6. Save configuration to EEPROM

🔧Troubleshooting

Can't Connect to Device

  • Ensure you're using Chrome, Edge, or another supported browser
  • Check that the WinKeyer USB is properly connected
  • Close any other applications that might be using the device
  • Try unplugging and reconnecting the WinKeyer USB
  • Refresh the web page and try connecting again

Settings Not Saving

  • Make sure Host Mode is open before writing settings
  • Always click "Write All Settings" after making changes
  • Use "Save Settings to EEPROM" for permanent storage
  • Some settings require a power cycle to take full effect

Memory Playback Issues

  • Check that Host Mode is open
  • Verify memory content is within 127 character limit
  • Use "Stop Playback" to clear any stuck playback
  • Try clearing and rewriting problematic memory slots

Using Raw Commands for Debugging

If you need to troubleshoot at a low level:

  • 0x04: Echo test - device should respond
  • 0x17: Get version information
  • 0x15: Get current status
  • 0x0A: Clear buffer (stop all activity)
  • Watch the console for responses and error messages

💡Tips and Best Practices

Performance Tips

  • Keep the console window open to monitor communication
  • Always open Host Mode for full functionality
  • Save settings to EEPROM after configuration
  • Use memory slots for frequently sent messages
  • Close other serial applications to avoid conflicts

Contest Preparation

  • Program all contest messages in advance
  • Test memory playback before the contest
  • Set appropriate competition word spacing
  • Configure auto-incrementing serial numbers
  • Keep the interface open during contests for quick changes

Security Considerations

  • Web Serial API requires HTTPS (automatically provided)
  • Only this website can access your selected device
  • No data is transmitted over the internet
  • All communication is local between browser and device
  • Settings are stored locally in your browser

Backup and Restore

  • Write down your preferred settings
  • Use "Read All Settings" to backup current config
  • Memory contents are stored in the device EEPROM
  • Consider keeping a text file of your memory messages
  • Settings survive device power cycles when saved to EEPROM