Manual - QMK

QMK

Install QMK

Install the QMK CLI

brew tap qmk/qmk
brew install qmk/qmk/qmk
qmk setup

Config QMK for development:

# Clone qmk_firmware into ~/
git clone --recurse-submodules git@github.com:lwkz/qmk_firmware.git
git branch checkout lwkz
 
# Alternatively, pull all the submodules (for the first time)
git submodule update --init --recursive
 
# or
git submodule update --recursive

Compile the QMK framework for your keyboard(s):

# Keyboard: Lulu with miryoku keymaps
qmk compile -c -kb boardsource/lulu/rp2040 -km manna-harbour_miryoku -e MIRYOKU_MAPPING=SPLIT
 
# Keyboard: Preonic v3 Drop.com
qmk compile -c -kb preonic/rev3_drop -km manna-harbour_miryoku

Useful utilities

Install other useful utilities:

# Install qmk-toolbox
brew tap homebrew/cask-drivers
brew install --cask qmk-toolbox
 
# Install Via and Vial
brew install --cask vial
brew install --cask via

Troubleshooting

# If the dfu configure is messed up on your keyboard for any reason
dfu-programmer atmega32u4 erase --force

ZMK

Using ZMK

My Cornish-Zen v2 (Group Buy 3) uses ZMK for Bluetooth support.

Bluetooth Operations

• Reference key code: &bt
• Clear paired host: BT_CLR
• Switch Bluetooth Profiles: BT_SEL <n> - n is the 0-indexed profile by number

With the standard Miryoku Colemak layout, you need the bottom row of your right-half keyboard on the media layer for switching the Bluetooth device. There are profiles 1 to 4 (starts with the h key for profile 1, not the k key). You press Shift plus the corresponding profile key to clear the profile.

References

• zmk.dev. (n.d.). Bluetooth Behavior | ZMK Firmware. [online] Available at: https://zmk.dev/docs/behaviors/bluetooth [Accessed 8 Apr. 2024].