QMK

What is QMK?


QMK (Quantum Mechanical Keyboard) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices.

1/0

Hardware

Software

Support

Functions

Layer Keys

  • eg: Hold to switch to layer

  • eg: Toggle layer On/Off

  • eg: Tap KC, hold to switch to layer

Remap any keys

  • eg: A - Z

  • eg: 1 - 0

  • eg: F1 - F24

Mod Combo Keys

  • eg: Cmd + Shift 

  • eg: Cmd + Shift + Alt

Mod Tap Keys

  • Tap KC, hold for Mod, such as Ctrl, Shift and Alt

Combo Keys

  • eg: Shift + W

  • eg: Cmd + Shift + S

  • eg: Cmd + Shift + Alt + I

Application Keys

  • eg: Power, Sleep, Wake

  • eg: Cut, Copy, Paste

  • eg: Brightness up and down

Multimedia Keys

  • eg: Next track/ Prev track

  • eg: Vol + / -

  • eg: Mute

Mouse Keys

  • Left click, Right click, Mid Click

  • Wheel up, down, left and right

  • Move mouse up, down, left and right

Keyboard Adjust Keys

  • BLE mode On / Off

  • USD mode On / Off

  • Reset all bluetooth connect setting

  • Connect or pair Device 1- 5

  • Reset Device setting 1 - 5

  • Dfu mode for flash keymap

  • Deep Sleep mode for save battery

  • Display Battery Level

... etc.

1/0

Step by Step


There are 4 main sections to this guide: 

1. Setup QMK 

2. Building Firmware 

3. Flashing Firmware 

4. Testing

1/0
1/0
1/0