README.md

   1 # Quantum MK Firmware
   2
   3 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.co) and the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard.
   4
   5 QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, TMK.
   6
   7 This documentation is edited and maintained by Erez Zukerman of ErgoDox EZ. If you spot any typos or inaccuracies, please [open an issue](https://github.com/jackhumbert/qmk_firmware/issues/new).
   8
   9 ## Important background info: TMK documentation
  10
  11 The documentation below explains QMK customizations and elaborates on some of the more useful features of TMK. To understand the base firmware, and especially what *layers* are and how they work, please see [TMK_README.md](/TMK_README.md).
  12
  13 ## Getting started
  14
  15 * **If you're looking to customize a keyboard that currently runs QMK or TMK** , find your keyboard's directory under `/keyboard/` and read the README file. This will get you all set up.
  16 * Read the [QUICK_START.md](QUICK_START.md) if you want to hit the ground running with minimal fuss or you aren't a technical person and you just want to build the firmware with the least amount of hassle possible.
  17 * If you're looking to apply this firmware to an entirely new hardware project (a new kind of keyboard), you can create your own Quantum-based project by using `./new_project.sh <project_name>`, which will create `/keyboard/<project_name>` with all the necessary components for a Quantum project.
  18
  19 You have access to a bunch of goodies! Check out the Makefile to enable/disable some of the features. Uncomment the `#` to enable them. Setting them to `no` does nothing and will only confuse future you.
  20
  21     BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
  22     MIDI_ENABLE = yes      # MIDI controls
  23     # UNICODE_ENABLE = yes # Unicode support - this is commented out, just as an example. You have to use #, not //
  24     BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
  25
  26 ## Quick aliases to common actions
  27
  28 Your keymap can include shortcuts to common operations (called "function actions" in tmk).
  29
  30 ### Switching and toggling layers
  31
  32 `MO(layer)` - momentary switch to *layer*. As soon as you let go of the key, the layer is deactivated and you pop back out to the previous layer. When you apply this to a key, that same key must be set as `KC_TRNS` on the destination layer. Otherwise, you won't make it back to the original layer when you release the key (and you'll get a keycode sent). You can only switch to layers *above* your current layer. If you're on layer 0 and you use `MO(1)`, that will switch to layer 1 just fine. But if you include `MO(3)` on layer 5, that won't do anything for you -- because layer 3 is lower than layer 5 on the stack.
  33
  34 `LT(layer, kc)` - momentary switch to *layer* when held, and *kc* when tapped. Like `MO()`, this only works upwards in the layer stack (`layer` must be higher than the current layer).
  35
  36 `TG(layer)` - toggles a layer on or off. As with `MO()`, you should set this key as `KC_TRNS` in the destination layer so that tapping it again actually toggles back to the original layer. Only works upwards in the layer stack.
  37
  38 ### Fun with modifier keys
  39
  40 * `LSFT(kc)` - applies left Shift to *kc* (keycode) - `S(kc)` is an alias
  41 * `RSFT(kc)` - applies right Shift to *kc*
  42 * `LCTL(kc)` - applies left Control to *kc*
  43 * `RCTL(kc)` - applies right Control to *kc*
  44 * `LALT(kc)` - applies left Alt to *kc*
  45 * `RALT(kc)` - applies right Alt to *kc*
  46 * `LGUI(kc)` - applies left GUI (command/win) to *kc*
  47 * `RGUI(kc)` - applies right GUI (command/win) to *kc*
  48 * `HYPR(kc)` - applies Hyper (all modifiers) to *kc*
  49 * `MEH(kc)`  - applies Meh (all modifiers except Win/Cmd) to *kc*
  50 * `LCAG(kc)` - applies CtrlAltGui to *kc*
  51
  52 You can also chain these, like this:
  53
  54     LALT(LCTL(KC_DEL)) -- this makes a key that sends Alt, Control, and Delete in a single keypress.
  55
  56 The following shortcuts automatically add `LSFT()` to keycodes to get commonly used symbols. Their long names are also available and documented in `/quantum/keymap_common.h`.
  57
  58     KC_TILD  ~
  59     KC_EXLM  !
  60     KC_AT    @
  61     KC_HASH  #
  62     KC_DLR   $
  63     KC_PERC  %
  64     KC_CIRC  ^
  65     KC_AMPR  &
  66     KC_ASTR  *
  67     KC_LPRN  (
  68     KC_RPRN  )
  69     KC_UNDS  _
  70     KC_PLUS  +
  71     KC_LCBR  {
  72     KC_RCBR  }
  73     KC_PIPE  |
  74     KC_COLN  :
  75
  76 `MT(mod, kc)` - is *mod* (modifier key - MOD_LCTL, MOD_LSFT) when held, and *kc* when tapped. In other words, you can have a key that sends Esc (or the letter O or whatever) when you tap it, but works as a Control key or a Shift key when you hold it down.
  77
  78 These are the values you can use for the `mod` in `MT()` (right-hand modifiers are not available):
  79
  80   * MOD_LCTL
  81   * MOD_LSFT
  82   * MOD_LALT
  83   * MOD_LGUI
  84
  85 These can also be combined like `MOD_LCTL | MOD_LSFT` e.g. `MT(MOD_LCTL | MOD_LSFT, KC_ESC)` which would activate Control and Shift when held, and send Escape when tapped.
  86
  87 We've added shortcuts to make common modifier/tap (mod-tap) mappings more compact:
  88
  89   * `CTL_T(kc)` - is LCTL when held and *kc* when tapped
  90   * `SFT_T(kc)` - is LSFT when held and *kc* when tapped
  91   * `ALT_T(kc)` - is LALT when held and *kc* when tapped
  92   * `GUI_T(kc)` - is LGUI when held and *kc* when tapped
  93   * `ALL_T(kc)` - is Hyper (all mods) when held and *kc* when tapped. To read more about what you can do with a Hyper key, see [this blog post by Brett Terpstra](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/)
  94   * `LCAG_T(kc)` - is CtrlAltGui when held and *kc* when tapped
  95   * `MEH_T(kc)` - is like Hyper, but not as cool -- does not include the Cmd/Win key, so just sends Alt+Ctrl+Shift.
  96
  97 ### Temporarily setting the default layer
  98
  99 `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.
 100
 101 ### Remember: These are just aliases
 102
 103 These functions work the same way that their `ACTION_*` functions do - they're just quick aliases. To dig into all of the tmk ACTION_* functions, please see the [TMK documentation](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keymap.md#2-action).
 104
 105 Instead of using `FNx` when defining `ACTION_*` functions, you can use `F(x)` - the benefit here is being able to use more than 32 function actions (up to 4096), if you happen to need them.
 106
 107 ## Macro shortcuts: Send a whole string when pressing just one key
 108
 109 Instead of using the `ACTION_MACRO` function, you can simply use `M(n)` to access macro *n* - *n* will get passed into the `action_get_macro` as the `id`, and you can use a switch statement to trigger it. This gets called on the keydown and keyup, so you'll need to use an if statement testing `record->event.pressed` (see keymap_default.c).
 110
 111 ```c
 112 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) // this is the function signature -- just copy/paste it into your keymap file as it is.
 113 {
 114   switch(id) {
 115     case 0: // this would trigger when you hit a key mapped as M(0)
 116       if (record->event.pressed) {
 117         return MACRO( I(255), T(H), T(E), T(L), T(L), W(255), T(O), END  ); // this sends the string 'hello' when the macro executes
 118       }
 119       break;
 120   }
 121   return MACRO_NONE;
 122 };
 123 ```
 124 A macro can include the following commands:
 125
 126 * I() change interval of stroke in milliseconds.
 127 * D() press key.
 128 * U() release key.
 129 * T() type key(press and release).
 130 * W() wait (milliseconds).
 131 * END end mark.
 132
 133 So above you can see the stroke interval changed to 255ms between each keystroke, then a bunch of keys being typed, waits a while, then the macro ends.
 134
 135 Note: Using macros to have your keyboard send passwords for you is a bad idea.
 136
 137 ### Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
 138
 139 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:
 140
 141    #include <keymap_extras/keymap_colemak.h>
 142
 143 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:
 144
 145  * `CM_*` for all of the Colemak-equivalent characters
 146  * `DV_*` for all of the Dvorak-equivalent characters
 147
 148 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.
 149
 150 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`.
 151
 152 ## Additional language support
 153
 154 In `quantum/keymap_extras/`, you'll see various language files - these work the same way as the alternative layout ones do. Most are defined by their two letter country/language code followed by an underscore and a 4-letter abbreviation of its name. `FR_UGRV` which will result in a `ù` when using a software-implemented AZERTY layout. It's currently difficult to send such characters in just the firmware (but it's being worked on - see Unicode support).
 155
 156 ## Unicode support
 157
 158 You can currently send 4 hex digits with your OS-specific modifier key (RALT for OSX with the "Unicode Hex Input" layout) - this is currently limited to supporting one OS at a time, and requires a recompile for switching. 8 digit hex codes are being worked on. The keycode function is `UC(n)`, where *n* is a 4 digit hexidecimal. Enable from the Makefile.
 159
 160 ## Other firmware shortcut keycodes
 161
 162 * `RESET` - puts the MCU in DFU mode for flashing new firmware (with `make dfu`)
 163 * `DEBUG` - the firmware into debug mode - you'll need hid_listen to see things
 164 * `BL_ON` - turns the backlight on
 165 * `BL_OFF` - turns the backlight off
 166 * `BL_<n>` - sets the backlight to level *n*
 167 * `BL_INC` - increments the backlight level by one
 168 * `BL_DEC` - decrements the backlight level by one
 169 * `BL_TOGG` - toggles the backlight
 170 * `BL_STEP` - steps through the backlight levels
 171
 172 Enable the backlight from the Makefile.
 173
 174 ## MIDI functionalty
 175
 176 This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
 177
 178 ## Bluetooth functionality
 179
 180 This requires [some hardware changes](https://www.reddit.com/r/MechanicalKeyboards/comments/3psx0q/the_planck_keyboard_with_bluetooth_guide_and/?ref=search_posts), but can be enabled via the Makefile. The firmware will still output characters via USB, so be aware of this when charging via a computer. It would make sense to have a switch on the Bluefruit to turn it off at will.
 181
 182 ## International Characters on Windows
 183
 184 [AutoHotkey](https://autohotkey.com) allows Windows users to create custom hotkeys amont others.
 185
 186 The method does not require Unicode support in the keyboard itself but depends instead of AutoHotkey running in the background.
 187
 188 First you need to select a modifier combination that is not in use by any of your programs.
 189 CtrlAltWin is not used very widely and should therefore be perfect for this.
 190 There is a macro defined for a mod-tab combo `LCAG_T`.
 191 Add this mod-tab combo to a key on your keyboard, e.g.: `LCAG_T(KC_TAB)`.
 192 This makes the key behave like a tab key if pressed and released immediately but changes it to the modifier if used with another key.
 193
 194 In the default script of AutoHotkey you can define custom hotkeys.
 195
 196     <^<!<#a::Send, ä
 197     <^<!<#<+a::Send, Ä
 198
 199 The hotkeys above are for the combination CtrlAltGui and CtrlAltGuiShift plus the letter a.
 200 AutoHotkey inserts the Text right of `Send, ` when this combination is pressed.
 201
 202 ## RGB Under Glow Mod
 203
 204 ![Planck with RGB Underglow](https://raw.githubusercontent.com/yangliu/qmk_firmware/planck-rgb/keyboard/planck/keymaps/yang/planck-with-rgb-underglow.jpg)
 205
 206 Here is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY).
 207
 208 For this mod, you need an unused pin wiring to DI of WS2812 strip. After wiring the VCC, GND, and DI, you can enable the underglow in your Makefile.
 209
 210     RGBLIGHT_ENABLE = yes
 211
 212 Please note that the underglow is not compatible with MIDI functions. So you cannot enable both of them at the same time.
 213
 214 Please add the following options into your config.h, and set them up according your hardware configuration.
 215
 216     #define ws2812_PORTREG  PORTF
 217     #define ws2812_DDRREG   DDRF
 218     #define ws2812_pin PF4
 219     #define RGBLED_NUM 14     // Number of LEDs
 220     #define RGBLIGHT_HUE_STEP 10
 221     #define RGBLIGHT_SAT_STEP 17
 222     #define RGBLIGHT_VAL_STEP 17
 223
 224 The firmware supports 5 different light effects, and the color (hue, saturation, brightness) can be customized in most effects. To control the underglow, you need to modify your keymap file to assign those functions to some keys/key combinations. For details, please check this keymap. `keyboard/planck/keymaps/yang/keymap.c`
 225
 226 ### WS2812 Wiring
 227
 228 ![WS2812 Wiring](https://raw.githubusercontent.com/yangliu/qmk_firmware/planck-rgb/keyboard/planck/keymaps/yang/WS2812-wiring.jpg)
 229
 230 Please note the USB port can only supply a limited amount of power to the keyboard (500mA by standard, however, modern computer and most usb hubs can provide 700+mA.). According to the data of NeoPixel from Adafruit, 30 WS2812 LEDs require a 5V 1A power supply, LEDs used in this mod should not more than 20.
 231
 232 ## Safety Considerations
 233
 234 You probably don't want to "brick" your keyboard, making it impossible
 235 to rewrite firmware onto it.  Here are some of the parameters to show
 236 what things are (and likely aren't) too risky.
 237
 238 - If a keyboard map does not include RESET, then, to get into DFU
 239   mode, you will need to press the reset button on the PCB, which
 240   requires unscrewing some bits.
 241 - Messing with tmk_core / common files might make the keyboard
 242   inoperable
 243 - Too large a .hex file is trouble; `make dfu` will erase the block,
 244   test the size (oops, wrong order!), which errors out, failing to
 245   flash the keyboard
 246 - DFU tools do /not/ allow you to write into the bootloader (unless
 247   you throw in extra fruitsalad of options), so there is little risk
 248   there.
 249 - EEPROM has around a 100000 write cycle.  You shouldn't rewrite the
 250   firmware repeatedly and continually; that'll burn the EEPROM
 251   eventually.