Skip to content

treitforge/wktools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

WKTools

Keyboard-first tools for WinKeyer configuration and management.

wktools-editor

A TUI editor for 300-byte WinKeyer WK3tools .eep EEPROM files.

Features

  • Keyboard-first navigation with Tab, arrow keys
  • Edit user profiles (Speed, Keyer Mode, Sidetone, Weight, PTT settings, etc.)
  • Global settings editor (First Extension, RTTY P1/P2)
  • Raw byte editor with hex/decimal support
  • Dirty-state protection (unsaved edits warning)
  • Validation on save

Installation

cargo install --path crates/wktools-editor

Usage

wktools-editor /path/to/config.eep

Navigation

  • Tab / Shift+Tab: Move between panes
  • Arrow Up/Down: Navigate fields within a pane
  • Enter / Space: Edit field (cycle enums, toggle bools, open input)
  • ?: Show help
  • Ctrl+S: Save
  • Ctrl+Q: Quit (warns if unsaved)

Keyboard Shortcuts

  • Tab: Next pane (User1 → User2 → Global → Raw)
  • Shift+Tab: Previous pane
  • /: Navigate field list
  • Enter: Open/edit selected field
  • Space: Toggle boolean fields or cycle enum values
  • ?: Help dialog
  • Ctrl+S: Save to file
  • Ctrl+Q: Quit (warns on unsaved changes)
  • Esc: Close input modal or help

WinKeyer EEPROM Layout

The .eep file is 300 bytes total:

Offset Size Content
0-15 16 User Profile 1
16-31 16 User Profile 2
32 1 First Extension (ms, 0-99)
48-49 2 RTTY P1/P2 (read-only)
50-299 250 Reserved

Each profile contains:

Offset Name Type Notes
0 Mode Register u8 Keyer mode (bits 4-5), flags (bits 0-3, 6-7)
1 X1 Register u8 Additional flags
2 Sidetone Divisor u8 62500 / divisor = Hz
3-5 X2/X3/X4 u8 Speed, command speed flags
6-15 Reserved u8 Padding

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

About

WinKeyer configuration editor and utilities

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages