@lzcontest/winkey

K1EL WinKey commands, codec, host-mode session, and connection profiles.

Install

npm install @lzcontest/winkey

Prepare a CW message

import {
  resolveWinKeyProfile,
  winKeyModelProfileIds,
  winKeySpeedWpm,
  winKeyText,
} from '@lzcontest/winkey';

const profile = resolveWinKeyProfile(winKeyModelProfileIds.versionThree);
const speed = winKeySpeedWpm(28);
const message = winKeyText('CQ TEST LZ9S');

console.log(profile?.model); // WinKeyer 3
console.log(speed, message);

Core API

| Export | Purpose | | --- | --- | | supportedWinKeyProfiles | Supported WinKey hardware profiles | | supportedWinKeyConnectionPresets | Documented virtual-port presets | | winKeySpeedWpm | Validate and brand a CW speed | | winKeyText | Validate text for WinKey transmission | | WinKeyCodec | Encode host commands and decode status frames | | WinKeySession | Host-open, transmission, status, abort, and cleanup lifecycle | | WinKeyRttySettings | WinKey 3 RTTY configuration |

License

AGPL-3.0-only