SwiftKeyer

SwiftKeyer is a native macOS application for the K1EL WinKeyerSerial, WinKeyerUSB, and WKMini. It provides a SwiftUI interface for sending CW text, editing and sending macros, configuring paddle behavior, and controlling the keyer speed. It was ported to Swift from my original Python application PyWinkeyerSerial.

It's primary purpose, other than a stand alone interface to the winkeyer, is to act as a CW interface for the not1mm contest logger.

The application listens for XML-RPC requests on 127.0.0.1:8000. The server is intentionally limited to the local machine so that the unauthenticated control API is not exposed to the network.

Requirements

• macOS 14 or later
• Xcode with Swift 6 support
• A connected WinKeyer-compatible device
• A user-accessible serial device such as /dev/cu.usbserial-*

The Binary

I've included a universal binary for MacOS 14+ in the releases section. UnZip it and drag it into your Application directory. You'll have to bypass gatekeeper, or locate the app in finder and hold Control while clicking on it, choose open in the pop up menu a couple times and it will be whitelisted.

Build and run from the command line

The Swift package is still the supported command-line build:

swift build
swift test
swift run SwiftKeyer

The executable can also be opened directly after building:

open .build/debug/SwiftKeyer

To create a release build:

swift build -c release

Serial connection

Connect the WinKeyer before starting the application. If exactly one serial device is available, it is selected automatically. The device path can also be chosen from the serial-device menu or entered directly.

The keyer uses 1200 baud, 8 data bits, no parity, and 2 stop bits. The application monitors speed-pot changes and sends a status request periodically.

Settings

The first launch creates ~/.pywinkeyer.json. The file remains compatible with the original Python application and stores:

• The selected serial device
• Six saved macros
• The paddle mode register

Edits to macros, the device path, or paddle settings are saved automatically. The keyer settings sheet maps directly to the WinKeyer mode-register bits.

XML-RPC API

The server accepts standard XML-RPC POST requests at /RPC2 and /. The supported methods are:

• k1elsendstring(text)
• setspeed(wordsPerMinute)
• sendblended(text)
• tuneon()
• tuneoff()
• clearbuffer()
• system.listMethods()
• system.methodHelp(method)
• system.methodSignature(method)

For example:

import xmlrpc.client

server = xmlrpc.client.ServerProxy("http://127.0.0.1:8000")
server.k1elsendstring("CQ TEST")

The RPC API has no authentication. Keep the server bound to loopback and do not expose port 8000 through a firewall or port forward.

Project layout

• Sources/SwiftKeyerCore contains the serial transport, WinKeyer protocol, settings, controller, and XML-RPC implementation.
• Sources/SwiftKeyerApp contains the SwiftUI application and app lifecycle.
• Sources/CSerialShim contains the small Darwin select and FIONREAD shim used by the serial port, along with the module map that exposes it to Swift.
• Tests/SwiftKeyerCoreTests contains protocol, settings, and XML-RPC tests.
• SwiftKeyer.xcodeproj is the Xcode project; it references the directories above in place rather than duplicating them.

The application is implemented entirely in Swift.