𝑥MK Uses and Testing

[manna-harbour]

Suggested things to try:

• Try with default keymaps (builds for QMK and ZMK can be downloaded from https://github.com/manna-harbour/xmk/actions)
• Try with Miryoku QMK, Miryoku ZMK, and Miryoku KMK (builds can be downloaded from https://github.com/manna-harbour/miryoku_qmk/actions, https://github.com/manna-harbour/miryoku_zmk/actions, and https://github.com/manna-harbour/miryoku_kmk/blob/main/src/build/main.py, respectively)
• Add your keymap to QMK converter/xmk (for keymaps with more than 128 keys, add more elements to rows in keyboards/converter/xmk/info.json)
• Add your keymap to ZMK xmk shield (for keymaps with more than 128 keys, create zmk-config/xmk.overlay with a &kscan section and override the values for rows and columns)
• Add your keymap to ZMK native_posix_64 board (for keymaps with more than 128 keys, edit zmk-config/native_posix_64.overlay to increase the values for rows or columns)
• Add your keymap to KMK xmk keyboard (for keymaps with more than 128 keys, add a key_count parameter to the KMKKeyboard() constructor in main.py)
• Test QMK on a pro-micro
• Test QMK on a different MCU (set the MCU, bootloader, etc. in the keymap as usual)
• Add a new layout to QMK (PRs welcome!)
• Enable via / vial / remap etc. in QMK
• Test ZMK xmk shield with a nice nano
• Test ZMK xmk shield with a different board
• Test ZMK xmk shield with BT hosts
• Test ZMK native_posix_64 board (note Zephyr usbip server not compatible with hold-tap behavior zmkfirmware/zmk#1444)
• Add bidirectional comms and key event generation to xmk script and key event output to ZMK shell to avoid using usbip with 𝑥MK Native
• Test KMK with KMK-compatible MCUs
• Test KMK with CircuitPython compatible MCUs (with enough flash and a hid module, see https://docs.circuitpython.org/en/latest/shared-bindings/support_matrix.html)
• Create a map (PRs welcome!)
• Use with a non-programmable keyboard
• Use with a programmable keyboard not compatible with QMK, ZMK, or KMK (set the keyboard to a custom keymap with no dual function keys)
• Use with a QMK, ZMK, or KMK keyboard (set the keyboard to a custom keymap with no dual function keys e.g. Miryoku Tap layer)
• Compare the feel of your QMK, ZMK, KMK, and KMonad keymaps on the same keyboard
• Ease transition to new keyboard with new firmware:
  • add a toggleable layer with no dual function keys to the new keyboard keymap, then fall back to existing QMK, ZMK, or KMK keymap via 𝑥MK
  • add a toggleable layer with no dual function keys to the existing keyboard keymap, then test new QMK, ZMK, or KMK keymap via 𝑥MK
• Playback src/recordings/hello_world with default keymap or with default Miryoku
• Record and playback to test keymap changes
• Record and playback to compare QMK, ZMK, and KMK keymap behaviour
• Multiple simultaneous instances of xmk redirecting to the same device
• Playback src/recordings/delay-test to ZMK native_posix_64 board with default keymap (see Demonstration of usbip timing issue #3)
• Resolve Zephyr usbip server not compatible with hold-tap behavior zmkfirmware/zmk#1444
• Review [Keyboard] Add converter/xmk qmk/qmk_firmware#18433
• Review Feature: shell tap command zmkfirmware/zmk#1318
• Test in a WSL or a Windows VM (xmk on Windows with WSL / Linux VM #4)
• Test in a macOS VM (test https://www.virtualhere.com/ for usbip)
• Test in ChromeOS
• Test in Android
• For use with laptops, use the ZMK native_posix_64 board, or MCU boards in USB dongle format
• Test QMK, ZMK xmk shield, and KMK, with MCU boards in USB dongle format, e.g.:
  • Adafruit Trinkey QT2040
  • Nordic nRF52840 Dongle
  • Raytac MDBT50Q-RX
  • Holyiot YJ-17017-USB, YJ-17076-USB, YJ-17120-USB [no reset button]
  • Makerdiary nRF52840 MDK
• Integrate xmk into KMK for use as a single process with no additional hardware requirements (https://kmkfw.zulipchat.com/#narrow/stream/358347-general/topic/.F0.9D.91.A5MK/near/325809928)
• Combine a Linux-compatible single-board computer such as Raspberry Pi with a ZMK MCU board to make a USB to BT converter that supports ZMK keymap features