docs/config_options.md

   1 # Configuring QMK
   2
   3 QMK is nearly infinitely configurable. Wherever possible we err on the side of allowing users to customize their keyboard, even at the expense of code size. That level of flexibility makes for a daunting configuration experience, however.
   4
   5 There are two main types of configuration files in QMK- `config.h` and `rules.mk`. These files exist at various levels in QMK and all files of the same type are combined to build the final configuration. The levels, from lowest priority to highest priority, are:
   6
   7 * QMK Default
   8 * Keyboard
   9 * Folders (Up to 5 levels deep)
  10 * Keymap
  11
  12 ## QMK Default
  13
  14 Every available setting in QMK has a default. If that setting is not set at the Keyboard, Folder, or Keymap level this is the setting that will be used.
  15
  16 ## Keyboard
  17
  18 This level contains config options that should apply to the whole keyboard. Some settings won't change in revisions, or most keymaps. Other settings are merely defaults for this keyboard and can be overridden by folders and/or keymaps.
  19
  20 ## Folders
  21
  22 Some keyboards have folders and sub-folders to allow for different hardware configurations. Most keyboards only go 1 folder deep, but QMK supports structures up to 5 folders deep. Each folder can have its own `config.h` and `rules.mk` files that are incorporated into the final configuration.
  23
  24 ## Keymap
  25
  26 This level contains all of the options for that particular keymap. If you wish to override a previous declaration, you can use `#undef <variable>` to undefine it, where you can then redefine it without an error.
  27
  28 # The `config.h` File
  29
  30 This is a C header file that is one of the first things included, and will persist over the whole project (if included). Lots of variables can be set here and accessed elsewhere. The `config.h` file shouldn't be including other `config.h` files, or anything besides this:
  31
  32     #include "config_common.h"
  33
  34
  35 ## Hardware Options
  36 * `#define VENDOR_ID 0x1234`
  37   * defines your VID, and for most DIY projects, can be whatever you want
  38 * `#define PRODUCT_ID 0x5678`
  39   * defines your PID, and for most DIY projects, can be whatever you want
  40 * `#define DEVICE_VER 0`
  41   * defines the device version (often used for revisions)
  42 * `#define MANUFACTURER Me`
  43   * generally who/whatever brand produced the board
  44 * `#define PRODUCT Board`
  45   * the name of the keyboard
  46 * `#define DESCRIPTION a keyboard`
  47   * a short description of what the keyboard is
  48 * `#define MATRIX_ROWS 5`
  49   * the number of rows in your keyboard's matrix
  50 * `#define MATRIX_COLS 15`
  51   * the number of columns in your keyboard's matrix
  52 * `#define MATRIX_ROW_PINS { D0, D5, B5, B6 }`
  53   * pins of the rows, from top to bottom
  54 * `#define MATRIX_COL_PINS { F1, F0, B0, C7, F4, F5, F6, F7, D4, D6, B4, D7 }`
  55   * pins of the columns, from left to right
  56 * `#define UNUSED_PINS { D1, D2, D3, B1, B2, B3 }`
  57   * pins unused by the keyboard for reference
  58 * `#define MATRIX_HAS_GHOST`
  59   * define is matrix has ghost (unlikely)
  60 * `#define DIODE_DIRECTION COL2ROW`
  61   * COL2ROW or ROW2COL - how your matrix is configured. COL2ROW means the black mark on your diode is facing to the rows, and between the switch and the rows.
  62 * `#define AUDIO_VOICES`
  63   * turns on the alternate audio voices (to cycle through)
  64 * `#define C4_AUDIO`
  65   * enables audio on pin C4
  66 * `#define C5_AUDIO`
  67   * enables audio on pin C5
  68 * `#define C6_AUDIO`
  69   * enables audio on pin C6
  70 * `#define B5_AUDIO`
  71   * enables audio on pin B5 (duophony is enables if one of B[5-7]_AUDIO is enabled along with one of C[4-6]_AUDIO)
  72 * `#define B6_AUDIO`
  73   * enables audio on pin B6 (duophony is enables if one of B[5-7]_AUDIO is enabled along with one of C[4-6]_AUDIO)
  74 * `#define B7_AUDIO`
  75   * enables audio on pin B7 (duophony is enables if one of B[5-7]_AUDIO is enabled along with one of C[4-6]_AUDIO)
  76 * `#define BACKLIGHT_PIN B7`
  77   * pin of the backlight - B5, B6, B7 use PWM, others use softPWM
  78 * `#define BACKLIGHT_LEVELS 3`
  79   * number of levels your backlight will have (maximum 15 excluding off)
  80 * `#define BACKLIGHT_BREATHING`
  81   * enables backlight breathing (only works with backlight pins B5, B6 and B7)
  82 * `#define BREATHING_PERIOD 6`
  83   * the length of one backlight "breath" in seconds
  84 * `#define DEBOUNCING_DELAY 5`
  85   * the delay when reading the value of the pin (5 is default)
  86 * `#define LOCKING_SUPPORT_ENABLE`
  87   * mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap
  88 * `#define LOCKING_RESYNC_ENABLE`
  89   * tries to keep switch state consistent with keyboard LED state
  90 * `#define IS_COMMAND() ( keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) )`
  91   * key combination that allows the use of magic commands (useful for debugging)
  92 * `#define USB_MAX_POWER_CONSUMPTION`
  93   * sets the maximum power (in mA) over USB for the device (default: 500)
  94 * `#define SCL_CLOCK 100000L`
  95   * sets the SCL_CLOCK speed for split keyboards. The default is `100000L` but some boards can be set to `400000L`.
  96
  97 ## Features That Can Be Disabled
  98
  99 If you define these options you will disable the associated feature, which can save on code size.
 100
 101 * `#define NO_DEBUG`
 102   * disable debugging
 103 * `#define NO_PRINT`
 104   * disable printing/debugging using hid_listen
 105 * `#define NO_ACTION_LAYER`
 106   * disable layers
 107 * `#define NO_ACTION_TAPPING`
 108   * disable tap dance and other tapping features
 109 * `#define NO_ACTION_ONESHOT`
 110   * disable one-shot modifiers
 111 * `#define NO_ACTION_MACRO`
 112   * disable old style macro handling: MACRO() & action_get_macro
 113 * `#define NO_ACTION_FUNCTION`
 114   * disable calling of action_function() from the fn_actions array (deprecated)
 115
 116 ## Features That Can Be Enabled
 117
 118 If you define these options you will enable the associated feature, which may increase your code size.
 119
 120 * `#define FORCE_NKRO`
 121   * NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots.
 122 * `#define STRICT_LAYER_RELEASE`
 123   * force a key release to be evaluated using the current layer stack instead of remembering which layer it came from (used for advanced cases)
 124
 125 ## Behaviors That Can Be Configured
 126
 127 * `#define TAPPING_TERM 200`
 128   * how long before a tap becomes a hold, if set above 500, a key tapped during the tapping term will turn it into a hold too
 129 * `#define RETRO_TAPPING`
 130   * tap anyway, even after TAPPING_TERM, if there was no other key interruption between press and release
 131   * See [Retro Tapping](feature_advanced_keycodes.md#retro-tapping) for details
 132 * `#define TAPPING_TOGGLE 2`
 133   * how many taps before triggering the toggle
 134 * `#define PERMISSIVE_HOLD`
 135   * makes tap and hold keys trigger the hold if another key is pressed before releasing, even if it hasn't hit the `TAPPING_TERM`
 136   * See [Permissive Hold](feature_advanced_keycodes.md#permissive-hold) for details
 137 * `#define IGNORE_MOD_TAP_INTERRUPT`
 138   * makes it possible to do rolling combos (zx) with keys that convert to other keys on hold, by enforcing the `TAPPING_TERM` for both keys.
 139   * See [Mod tap interrupt](feature_advanced_keycodes.md#ignore-mod-tap-interrupt) for details
 140 * `#define TAPPING_FORCE_HOLD`
 141   * makes it possible to use a dual role key as modifier shortly after having been tapped
 142   * See [Hold after tap](feature_advanced_keycodes.md#tapping-force-hold)
 143   * Breaks any Tap Toggle functionality (`TT` or the One Shot Tap Toggle)
 144 * `#define LEADER_TIMEOUT 300`
 145   * how long before the leader key times out
 146     * If you're having issues finishing the sequence before it times out, you may need to increase the timeout setting. Or you may want to enable the `LEADER_PER_KEY_TIMING` option, which resets the timeout after each key is tapped.
 147 * `#define LEADER_PER_KEY_TIMING`
 148   * sets the timer for leader key chords to run on each key press rather than overall
 149 * `#define LEADER_KEY_STRICT_KEY_PROCESSING`
 150   * Disables keycode filtering for Mod-Tap and Layer-Tap keycodes. Eg, if you enable this, you would need to specify `MT(MOD_CTL, KC_A)` if you want to use `KC_A`.
 151 * `#define ONESHOT_TIMEOUT 300`
 152   * how long before oneshot times out
 153 * `#define ONESHOT_TAP_TOGGLE 2`
 154   * how many taps before oneshot toggle is triggered
 155 * `#define QMK_KEYS_PER_SCAN 4`
 156   * Allows sending more than one key per scan. By default, only one key event gets
 157     sent via `process_record()` per scan. This has little impact on most typing, but
 158     if you're doing a lot of chords, or your scan rate is slow to begin with, you can
 159     have some delay in processing key events. Each press and release is a separate
 160     event. For a keyboard with 1ms or so scan times, even a very fast typist isn't
 161     going to produce the 500 keystrokes a second needed to actually get more than a
 162     few ms of delay from this. But if you're doing chording on something with 3-4ms
 163     scan times? You probably want this.
 164 * `#define COMBO_COUNT 2`
 165   * Set this to the number of combos that you're using in the [Combo](feature_combo.md) feature.
 166 * `#define COMBO_TERM 200`
 167   * how long for the Combo keys to be detected. Defaults to `TAPPING_TERM` if not defined.
 168 * `#define TAP_CODE_DELAY 100`
 169   * Sets the delay between `register_code` and `unregister_code`, if you're having issues with it registering properly (common on VUSB boards). The value is in milliseconds.
 170
 171 ## RGB Light Configuration
 172
 173 * `#define RGB_DI_PIN D7`
 174   * pin the DI on the ws2812 is hooked-up to
 175 * `#define RGBLIGHT_ANIMATIONS`
 176   * run RGB animations
 177 * `#define RGBLED_NUM 15`
 178   * number of LEDs
 179 * `#define RGBLIGHT_HUE_STEP 12`
 180   * units to step when in/decreasing hue
 181 * `#define RGBLIGHT_SAT_STEP 25`
 182   * units to step when in/decreasing saturation
 183 * `#define RGBLIGHT_VAL_STEP 12`
 184   * units to step when in/decreasing value (brightness)
 185 * `#define RGBW_BB_TWI`
 186   * bit-bangs TWI to EZ RGBW LEDs (only required for Ergodox EZ)
 187
 188 ## Mouse Key Options
 189
 190 * `#define MOUSEKEY_INTERVAL 20`
 191 * `#define MOUSEKEY_DELAY 0`
 192 * `#define MOUSEKEY_TIME_TO_MAX 60`
 193 * `#define MOUSEKEY_MAX_SPEED 7`
 194 * `#define MOUSEKEY_WHEEL_DELAY 0`
 195
 196 ## Split Keyboard Options
 197
 198 Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk
 199
 200 * `SPLIT_TRANSPORT = custom`
 201   * Allows replacing the standard split communication routines with a custom one. ARM based split keyboards must use this at present.
 202
 203 ### Setting Handedness
 204
 205 One thing to remember, the side that the USB port is plugged into is always the master half. The side not plugged into USB is the slave.
 206
 207 There are a few different ways to set handedness for split keyboards (listed in order of precedence):
 208
 209 1. Set `SPLIT_HAND_PIN`: Reads a pin to determine handedness. If pin is high, it's the left side, if low, the half is determined to be the right side
 210 2. Set `EE_HANDS` and flash `eeprom-lefthand.eep`/`eeprom-righthand.eep` to each half
 211 3. Set `MASTER_RIGHT`: Half that is plugged into the USB port is determined to be the master and right half (inverse of the default)
 212 4. Default: The side that is plugged into the USB port is the master half and is assumed to be the left half. The slave side is the right half
 213
 214 * `#define SPLIT_HAND_PIN B7`
 215   * For using high/low pin to determine handedness, low = right hand, high = left hand. Replace `B7` with the pin you are using. This is optional, and if you leave `SPLIT_HAND_PIN` undefined, then you can still use the EE_HANDS method or MASTER_LEFT / MASTER_RIGHT defines like the stock Let's Split uses.
 216
 217 * `#define EE_HANDS` (only works if `SPLIT_HAND_PIN` is not defined)
 218   * Reads the handedness value stored in the EEPROM after `eeprom-lefthand.eep`/`eeprom-righthand.eep` has been flashed to their respective halves.
 219
 220 * `#define MASTER_RIGHT`
 221   * Master half is defined to be the right half.
 222
 223 ### Other Options
 224
 225 * `#define USE_I2C`
 226   * For using I2C instead of Serial (defaults to serial)
 227
 228 * `#define SOFT_SERIAL_PIN D0`
 229   * When using serial, define this. `D0` or `D1`,`D2`,`D3`,`E6`.
 230
 231 * `#define MATRIX_ROW_PINS_RIGHT { <row pins> }`
 232 * `#define MATRIX_COL_PINS_RIGHT { <col pins> }`
 233   * If you want to specify a different pinout for the right half than the left half, you can define `MATRIX_ROW_PINS_RIGHT`/`MATRIX_COL_PINS_RIGHT`. Currently, the size of `MATRIX_ROW_PINS` must be the same as `MATRIX_ROW_PINS_RIGHT` and likewise for the definition of columns.
 234
 235 * `#define SELECT_SOFT_SERIAL_SPEED <speed>` (default speed is 1)
 236   * Sets the protocol speed when using serial communication
 237   * Speeds:
 238     * 0: about 189kbps (Experimental only)
 239     * 1: about 137kbps (default)
 240     * 2: about 75kbps
 241     * 3: about 39kbps
 242     * 4: about 26kbps
 243     * 5: about 20kbps
 244
 245 # The `rules.mk` File
 246
 247 This is a [make](https://www.gnu.org/software/make/manual/make.html) file that is included by the top-level `Makefile`. It is used to set some information about the MCU that we will be compiling for as well as enabling and disabling certain features.
 248
 249 ## Build Options
 250
 251 * `DEFAULT_FOLDER`
 252   * Used to specify a default folder when a keyboard has more than one sub-folder.
 253 * `FIRMWARE_FORMAT`
 254   * Defines which format (bin, hex) is copied to the root `qmk_firmware` folder after building.
 255 * `SRC`
 256   * Used to add files to the compilation/linking list.
 257 * `LAYOUTS`
 258   * A list of [layouts](feature_layouts.md) this keyboard supports.
 259
 260 ## AVR MCU Options
 261 * `MCU = atmega32u4`
 262 * `F_CPU = 16000000`
 263 * `ARCH = AVR8`
 264 * `F_USB = $(F_CPU)`
 265 * `OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT`
 266 * `BOOTLOADER = atmel-dfu` with the following options:
 267   * `atmel-dfu`
 268   * `lufa-dfu`
 269   * `qmk-dfu`
 270   * `halfkay`
 271   * `caterina`
 272   * `bootloadHID`
 273
 274 ## Feature Options
 275
 276 Use these to enable or disable building certain features. The more you have enabled the bigger your firmware will be, and you run the risk of building a firmware too large for your MCU.
 277
 278 * `BOOTMAGIC_ENABLE`
 279   * Virtual DIP switch configuration(+1000)
 280 * `MOUSEKEY_ENABLE`
 281   * Mouse keys(+4700)
 282 * `EXTRAKEY_ENABLE`
 283   * Audio control and System control(+450)
 284 * `CONSOLE_ENABLE`
 285   * Console for debug(+400)
 286 * `COMMAND_ENABLE`
 287   * Commands for debug and configuration
 288 * `COMBO_ENABLE`
 289   * Key combo feature
 290 * `NKRO_ENABLE`
 291   * USB N-Key Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
 292 * `AUDIO_ENABLE`
 293   * Enable the audio subsystem.
 294 * `RGBLIGHT_ENABLE`
 295   * Enable keyboard underlight functionality
 296 * `LEADER_ENABLE`
 297   * Enable leader key chording
 298 * `MIDI_ENABLE`
 299   * MIDI controls
 300 * `UNICODE_ENABLE`
 301   * Unicode
 302 * `BLUETOOTH_ENABLE`
 303   * Legacy option to Enable Bluetooth with the Adafruit EZ-Key HID. See BLUETOOTH
 304 * `BLUETOOTH`
 305   * Current options are AdafruitEzKey, AdafruitBLE, RN42
 306 * `SPLIT_KEYBOARD`
 307   * Enables split keyboard support (dual MCU like the let's split and bakingpy's boards) and includes all necessary files located at quantum/split_common
 308 * `CUSTOM_MATRIX`
 309   * Allows replacing the standard matrix scanning routine with a custom one.
 310 * `CUSTOM_DEBOUNCE`
 311   * Allows replacing the standard key debouncing routine with a custom one.
 312 * `WAIT_FOR_USB`
 313   * Forces the keyboard to wait for a USB connection to be established before it starts up
 314 * `NO_USB_STARTUP_CHECK`
 315   * Disables usb suspend check after keyboard startup. Usually the keyboard waits for the host to wake it up before any tasks are performed. This is useful for split keyboards as one half will not get a wakeup call but must send commands to the master.
 316
 317 ## USB Endpoint Limitations
 318
 319 In order to provide services over USB, QMK has to use USB endpoints.
 320 These are a finite resource: each microcontroller has only a certain number.
 321 This limits what features can be enabled together.
 322 If the available endpoints are exceeded, a build error is thrown.
 323
 324 The following features can require separate endpoints:
 325
 326 * `MOUSEKEY_ENABLE`
 327 * `EXTRAKEY_ENABLE`
 328 * `CONSOLE_ENABLE`
 329 * `NKRO_ENABLE`
 330 * `MIDI_ENABLE`
 331 * `RAW_ENABLE`
 332 * `VIRTSER_ENABLE`
 333
 334 In order to improve utilisation of the endpoints, the HID features can be combined to use a single endpoint.
 335 By default, `MOUSEKEY`, `EXTRAKEY`, and `NKRO` are combined into a single endpoint.
 336
 337 The base keyboard functionality can also be combined into the endpoint,
 338 by setting `KEYBOARD_SHARED_EP = yes`.
 339 This frees up one more endpoint,
 340 but it can prevent the keyboard working in some BIOSes,
 341 as they do not implement Boot Keyboard protocol switching.
 342
 343 Combining the mouse also breaks Boot Mouse compatibility.
 344 The mouse can be uncombined by setting `MOUSE_SHARED_EP = no` if this functionality is required.