Home.md

   1 # Quantum Mechanical Keyboard Firmware
   2
   3 You have found the QMK Firmware documentation site. This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.
   4
   5 Understanding the essential changes made on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) should help you understand the QMK Firmware.
   6
   7 | Firmware                     |TMK                    |QMK                      |
   8 |------------------------------|-----------------------|-------------------------|
   9 | Maintainer                   |hasu  (@tmk)           |Jack Humbert et al.      |
  10 | Build path customization     | `TMK_DIR = ...`       | `include .../Makefile`  |
  11 | `keymaps` array data | 3D array of `uint8_t`  holding **keycode**      | 3D array of `uint16_t` holding **action code**  |
  12 | `fn_actions` array data  | 1D array of `uint16_t`  holding **action code** | 1D array of `uint16_t` holding **action code**  |
  13
  14 # Getting started
  15
  16 Before you are able to compile, you'll need to install an environment for AVR development. You'll find the instructions for any OS below. If you find another/better way to set things up from scratch, please consider [making a pull request](https://github.com/qmk/qmk_firmware/pulls) with your changes!
  17
  18 * [Build Environment Setup](Build-Environment-Setup)
  19 * [QMK Overview](QMK-Overview)
  20
  21 # Configuring QMK Firmware
  22
  23 The QMK Firmware can be configured via the `keymaps` array data.
  24
  25 For simply generating a [basic keycode](https://github.com/qmk/qmk_firmware/wiki/Keycodes), you add it as an element of your `keymaps` array data.
  26
  27 For more complicated actions, you add the corresponding **action code** directly as an element of your `keymaps` array data.
  28
  29 The **action code** is a 16 bit data and organized carefully to represent common operations with the combination of C macros.  It is sometimes called quantum keycode in the QMK source comment.
  30
  31 For example, the keycode `KC_8` as an element of your `keymaps` array data is for generating keystroke of "8".  The action code `SHFT(KC_8)` an element of your `keymaps` array data is for generating key stroke of "*" which is "8" key shifted.
  32
  33 Please note only up to 32 **action codes** were usable in `fn_actions` array data and accessed via special keycodes (`KC_FN0` to `KC_FN31`) in `keymaps` array data in tmk.
  34
  35 For more details of the `keymaps` array, see [Keymap Overview](Keymap) page.
  36
  37 ## C macro functions for action code
  38
  39 Basic C macro functions is documented in the [Key Functions](Key-Functions) page.
  40
  41 There are several new standardized support for common operations with new action codes as follows.
  42
  43 ## Space Cadet Shift: The future, built in
  44
  45 Steve Losh [described](http://stevelosh.com/blog/2012/10/a-modern-space-cadet/) the Space Cadet Shift quite well. Essentially, you hit the left Shift on its own, and you get an opening parenthesis; hit the right Shift on its own, and you get the closing one. When hit with other keys, the Shift key keeps working as it always does. Yes, it's as cool as it sounds. Head on over to the [Space Cadet Shift](Space-Cadet-Shift) page to read about it.
  46
  47 ## The Leader key: A new kind of modifier
  48
  49 Most modifiers have to be held or toggled. But what if you had a key that indicated the start of a sequence? You could press that key and then rapidly press 1-3 more keys to trigger a macro, or enter a special layer, or anything else you might want to do. To learn more about it check out the [Leader Key](Leader-Key) page.
  50
  51 ## Tap Dance: A single key can do 3, 5, or 100 different things
  52
  53 Hit the semicolon key once, send a semicolon. Hit it twice, rapidly -- send a colon. Hit it three times, and your keyboard's LEDs do a wild dance. That's just one example of what Tap Dance can do. Read more about it on the [Tap Dance](Tap-Dance) page.
  54
  55 ## Temporarily setting the default layer
  56
  57 `DF(layer)` - sets default layer to *layer*. The default layer is the one at the "bottom" of the layer stack - the ultimate fallback layer. This currently does not persist over power loss. When you plug the keyboard back in, layer 0 will always be the default. It is theoretically possible to work around that, but that's not what `DF` does.
  58
  59 ## Macro shortcuts: Send a whole string when pressing just one key
  60
  61 How would you like a single keypress to send a whole word, sentence, paragraph, or even document? Head on over to the [Macros](Macros) page to read up on all aspects of Simple and Dynamic Macros.
  62
  63 ## Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
  64
  65 Everything is assuming you're in Qwerty (in software) by default, but there is built-in support for using a Colemak or Dvorak layout by including this at the top of your keymap:
  66
  67     #include <keymap_colemak.h>
  68
  69 If you use Dvorak, use `keymap_dvorak.h` instead of `keymap_colemak.h` for this line. After including this line, you will get access to:
  70
  71  * `CM_*` for all of the Colemak-equivalent characters
  72  * `DV_*` for all of the Dvorak-equivalent characters
  73
  74 These implementations assume you're using Colemak or Dvorak on your OS, not on your keyboard - this is referred to as a software-implemented layout. If your computer is in Qwerty and your keymap is in Colemak or Dvorak, this is referred to as a firmware-implemented layout, and you won't need these features.
  75
  76 To give an example, if you're using software-implemented Colemak, and want to get an `F`, you would use `CM_F` - `KC_F` under these same circumstances would result in `T`.
  77
  78 ## Backlight Breathing
  79
  80 In order to enable backlight breathing, the following line must be added to your config.h file.
  81
  82     #define BACKLIGHT_BREATHING
  83
  84 The following function calls are used to control the breathing effect.
  85
  86 * ```breathing_enable()``` - Enable the free-running breathing effect.
  87 * ```breathing_disable()``` - Disable the free-running breathing effect immediately.
  88 * ```breathing_self_disable()``` - Disable the free-running breathing effect after the current effect ends.
  89 * ```breathing_toggle()``` - Toggle the free-running breathing effect.
  90 * ```breathing_defaults()``` - Reset the speed and brightness settings of the breathing effect.
  91
  92 The following function calls are used to control the maximum brightness of the breathing effect.
  93
  94 * ```breathing_intensity_set(value)``` - Set the brightness of the breathing effect when it is at its max value.
  95 * ```breathing_intensity_default()``` - Reset the brightness of the breathing effect to the default value based on the current backlight intensity.
  96
  97 The following function calls are used to control the cycling speed of the breathing effect.
  98
  99 * ```breathing_speed_set(value)``` - Set the speed of the breathing effect - how fast it cycles.
 100 * ```breathing_speed_inc(value)``` - Increase the speed of the breathing effect by a fixed value.
 101 * ```breathing_speed_dec(value)``` - Decrease the speed of the breathing effect by a fixed value.
 102 * ```breathing_speed_default()``` - Reset the speed of the breathing effect to the default value.
 103
 104 The following example shows how to enable the backlight breathing effect when the FUNCTION layer macro button is pressed:
 105
 106     case MACRO_FUNCTION:
 107         if (record->event.pressed)
 108         {
 109             breathing_speed_set(3);
 110             breathing_enable();
 111             layer_on(LAYER_FUNCTION);
 112         }
 113         else
 114         {
 115             breathing_speed_set(1);
 116             breathing_self_disable();
 117             layer_off(LAYER_FUNCTION);
 118         }
 119         break;
 120
 121 The following example shows how to pulse the backlight on-off-on when the RAISED layer macro button is pressed:
 122
 123     case MACRO_RAISED:
 124       if (record->event.pressed)
 125       {
 126         layer_on(LAYER_RAISED);
 127         breathing_speed_set(2);
 128         breathing_pulse();
 129         update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
 130       }
 131       else
 132       {
 133         layer_off(LAYER_RAISED);
 134         update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
 135       }
 136       break;
 137
 138 ## Other firmware shortcut keycodes
 139
 140 * `RESET` - puts the MCU in DFU mode for flashing new firmware (with `make dfu`)
 141 * `DEBUG` - the firmware into debug mode - you'll need hid_listen to see things
 142 * `BL_ON` - turns the backlight on
 143 * `BL_OFF` - turns the backlight off
 144 * `BL_<n>` - sets the backlight to level *n*
 145 * `BL_INC` - increments the backlight level by one
 146 * `BL_DEC` - decrements the backlight level by one
 147 * `BL_TOGG` - toggles the backlight
 148 * `BL_STEP` - steps through the backlight levels
 149
 150 Enable the backlight from the Makefile.
 151
 152 # Custom Quantum functions
 153
 154 All of these functions are available in the `*_kb()` or `*_user()` variety. `kb` ones should only be used in the `<keyboard>/<keyboard>.c` file, and `user` ones should only be used in the `keymap.c`. The keyboard ones call the user ones - it's necessary to keep these calls to allow the keymap functions to work correctly.
 155
 156 ## `void matrix_init_*(void)`
 157
 158 This function gets called when the matrix is initiated, and can contain start-up code for your keyboard/keymap.
 159
 160 ## `void matrix_scan_*(void)`
 161
 162 This function gets called at every matrix scan, which is basically as often as the MCU can handle. Be careful what you put here, as it will get run a lot.
 163
 164 ## `bool process_record_*(uint16_t keycode, keyrecord_t *record)`
 165
 166 This function gets called on every keypress/release, and is where you can define custom functionality. The return value is whether or not QMK should continue processing the keycode - returning `false` stops the execution.
 167
 168 The `keycode` variable is whatever is defined in your keymap, eg `MO(1)`, `KC_L`, etc. and can be switch-cased to execute code whenever a particular code is pressed.
 169
 170 The `record` variable contains infomation about the actual press:
 171
 172 ```
 173 keyrecord_t record {
 174   keyevent_t event {
 175     keypos_t key {
 176       uint8_t col
 177       uint8_t row
 178     }
 179     bool     pressed
 180     uint16_t time
 181   }
 182 }
 183 ```
 184
 185 The conditional `if (record->event.pressed)` can tell if the key is being pressed or released, and you can execute code based on that.
 186
 187 ## `void led_set_*(uint8_t usb_led)`
 188
 189 This gets called whenever there is a state change on your host LEDs (eg caps lock, scroll lock, etc). The LEDs are defined as:
 190
 191 ```
 192 #define USB_LED_NUM_LOCK                0
 193 #define USB_LED_CAPS_LOCK               1
 194 #define USB_LED_SCROLL_LOCK             2
 195 #define USB_LED_COMPOSE                 3
 196 #define USB_LED_KANA                    4
 197 ```
 198
 199 and can be tested against the `usb_led` with a conditional like `if (usb_led & (1<<USB_LED_CAPS_LOCK))` - if this is true, you can turn your LED on, otherwise turn it off.