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 # Getting started
   6
   7 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!
   8
   9 * [Build Environment Setup](Build-Environment-Setup)
  10 * [QMK Overview](QMK-Overview)
  11
  12 # Going beyond the keycodes
  13
  14 Aside from the [basic keycodes](https://github.com/qmk/qmk_firmware/wiki/Keycodes), your keymap can include shortcuts to common operations.
  15
  16 ## Quick aliases to common actions
  17
  18 Your keymap can include shortcuts to common operations (called "function actions" in tmk). To learn more about them check out the [Key Functions](Key-Functions) page.
  19
  20 ## Space Cadet Shift: The future, built in
  21
  22 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.
  23
  24 ## The Leader key: A new kind of modifier
  25
  26 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.
  27
  28 ## Tap Dance: A single key can do 3, 5, or 100 different things
  29
  30 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.
  31
  32 ## Temporarily setting the default layer
  33
  34 `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.
  35
  36 ## Macro shortcuts: Send a whole string when pressing just one key
  37
  38 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.
  39
  40 ## Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
  41
  42 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:
  43
  44     #include <keymap_colemak.h>
  45
  46 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:
  47
  48  * `CM_*` for all of the Colemak-equivalent characters
  49  * `DV_*` for all of the Dvorak-equivalent characters
  50
  51 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.
  52
  53 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`.
  54
  55 ## Backlight Breathing
  56
  57 In order to enable backlight breathing, the following line must be added to your config.h file.
  58
  59     #define BACKLIGHT_BREATHING
  60
  61 The following function calls are used to control the breathing effect.
  62
  63 * ```breathing_enable()``` - Enable the free-running breathing effect.
  64 * ```breathing_disable()``` - Disable the free-running breathing effect immediately.
  65 * ```breathing_self_disable()``` - Disable the free-running breathing effect after the current effect ends.
  66 * ```breathing_toggle()``` - Toggle the free-running breathing effect.
  67 * ```breathing_defaults()``` - Reset the speed and brightness settings of the breathing effect.
  68
  69 The following function calls are used to control the maximum brightness of the breathing effect.
  70
  71 * ```breathing_intensity_set(value)``` - Set the brightness of the breathing effect when it is at its max value.
  72 * ```breathing_intensity_default()``` - Reset the brightness of the breathing effect to the default value based on the current backlight intensity.
  73
  74 The following function calls are used to control the cycling speed of the breathing effect.
  75
  76 * ```breathing_speed_set(value)``` - Set the speed of the breathing effect - how fast it cycles.
  77 * ```breathing_speed_inc(value)``` - Increase the speed of the breathing effect by a fixed value.
  78 * ```breathing_speed_dec(value)``` - Decrease the speed of the breathing effect by a fixed value.
  79 * ```breathing_speed_default()``` - Reset the speed of the breathing effect to the default value.
  80
  81 The following example shows how to enable the backlight breathing effect when the FUNCTION layer macro button is pressed:
  82
  83     case MACRO_FUNCTION:
  84         if (record->event.pressed)
  85         {
  86             breathing_speed_set(3);
  87             breathing_enable();
  88             layer_on(LAYER_FUNCTION);
  89         }
  90         else
  91         {
  92             breathing_speed_set(1);
  93             breathing_self_disable();
  94             layer_off(LAYER_FUNCTION);
  95         }
  96         break;
  97
  98 The following example shows how to pulse the backlight on-off-on when the RAISED layer macro button is pressed:
  99
 100     case MACRO_RAISED:
 101       if (record->event.pressed)
 102       {
 103         layer_on(LAYER_RAISED);
 104         breathing_speed_set(2);
 105         breathing_pulse();
 106         update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
 107       }
 108       else
 109       {
 110         layer_off(LAYER_RAISED);
 111         update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
 112       }
 113       break;
 114
 115 ## Other firmware shortcut keycodes
 116
 117 * `RESET` - puts the MCU in DFU mode for flashing new firmware (with `make dfu`)
 118 * `DEBUG` - the firmware into debug mode - you'll need hid_listen to see things
 119 * `BL_ON` - turns the backlight on
 120 * `BL_OFF` - turns the backlight off
 121 * `BL_<n>` - sets the backlight to level *n*
 122 * `BL_INC` - increments the backlight level by one
 123 * `BL_DEC` - decrements the backlight level by one
 124 * `BL_TOGG` - toggles the backlight
 125 * `BL_STEP` - steps through the backlight levels
 126
 127 Enable the backlight from the Makefile.
 128
 129 # Custom Quantum functions
 130
 131 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.
 132
 133 ## `void matrix_init_*(void)`
 134
 135 This function gets called when the matrix is initiated, and can contain start-up code for your keyboard/keymap.
 136
 137 ## `void matrix_scan_*(void)`
 138
 139 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.
 140
 141 ## `bool process_record_*(uint16_t keycode, keyrecord_t *record)`
 142
 143 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.
 144
 145 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.
 146
 147 The `record` variable contains infomation about the actual press:
 148
 149 ```
 150 keyrecord_t record {
 151   keyevent_t event {
 152     keypos_t key {
 153       uint8_t col
 154       uint8_t row
 155     }
 156     bool     pressed
 157     uint16_t time
 158   }
 159 }
 160 ```
 161
 162 The conditional `if (record->event.pressed)` can tell if the key is being pressed or released, and you can execute code based on that.
 163
 164 ## `void led_set_*(uint8_t usb_led)`
 165
 166 This gets called whenever there is a state change on your host LEDs (eg caps lock, scroll lock, etc). The LEDs are defined as:
 167
 168 ```
 169 #define USB_LED_NUM_LOCK                0
 170 #define USB_LED_CAPS_LOCK               1
 171 #define USB_LED_SCROLL_LOCK             2
 172 #define USB_LED_COMPOSE                 3
 173 #define USB_LED_KANA                    4
 174 ```
 175
 176 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.