Skip to content
ngzh edited this page Apr 9, 2024 · 1 revision

Welcome to the zmk-config wiki!

Terminologies

TODO

Keymaps

Keymaps are located in the shields folder respectively, with a =.keymap= suffix.

https://github.com/anisehid/zmk-config/tree/main/config/boards/shields

Pairing

Pairing the keyboard to a computer/phone/tablet

The central can pair up to 5 Bluetooth devices. It is done by MODE3 + Q/W/E/R/T to select pairing channels and then setup the pairing on computers/tablets/phones as a normal Bluetooth keyboard. The pairing is clear by MODE3 + D. If a channel is already paired with other device it won't work with new devices, so you can press MODE3 + Q, MODE3 + D, MODE3 + Q to ensure the channel is clear when pairing a device to channel 1 for example.

MODE3 is [The key to the right of left space bar, and the left CTRL] on smaller 60% keyboards, and [The key to the right of left CTRL] on larger 85% keyboards).

The keyboard can be used as a USB keyboard, by connecting the left keyboard (central side) with USB cord (ensure the cord is capable for data transmission, notice that some TypeC to TypeC cord won't work, TypeA to TypeC are better) to computers. The keyboard should switch to USB mode when plugged but still you can switch to bluetooth by MODE3 + Q/W/E/R/T and switch back to USB by MODE3 + S.

Pairing the left and right side

The pairing of left and right side (central and peripheral side in ZMK terms) is done by reset (pressing reset button or power on at the same time, which means within a few hundreds ms) the two sides at the same time.

Once the pairing is done (The keyboard you have, if not specifically mentioned, are all paired for left and right), there would be a piece of pairing status stored in the ROM of both controllers, and it won't be altered if you update the firmware with a different keymap.

You can test the pairing of left and right by toggling the LED. (In default keymaps, the LED toggling is done by MODE 3 [The key to the right of left space bar, and the left CTRL] + ESC on smaller 60% keyboards, and MODE 3 [The key to the right of left CTRL] + ` on larger 85% keyboards). It won't work for 100%, if it doesn't works you can try to reset left and right respectively.

If you like to clear the pairing of left and right, you need to flash this firmware to both side. https://github.com/anisehid/zmk-config/raw/main/tools/settings_reset.uf2 And after flashing of this firmware you need to flash a new normal firmware and redo the left and right pairing.