quantum/template/README.md

   1 %KEYBOARD% keyboard firmware
   2 ======================
   3
   4 ## Quantum MK Firmware
   5
   6 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.
   7
   8     BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
   9     MIDI_ENABLE = yes      # MIDI controls
  10     # UNICODE_ENABLE = yes # Unicode support - this is commented out, just as an example. You have to use #, not //
  11     BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
  12
  13 ## Quick aliases to common actions
  14
  15 Your keymap can include shortcuts to common operations (called "function actions" in tmk).
  16
  17 ### Switching and toggling layers
  18
  19 `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.
  20
  21 `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).
  22
  23 `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.
  24
  25 ### Fun with modifier keys
  26
  27 * `LSFT(kc)` - applies left Shift to *kc* (keycode) - `S(kc)` is an alias
  28 * `RSFT(kc)` - applies right Shift to *kc*
  29 * `LCTL(kc)` - applies left Control to *kc*
  30 * `RCTL(kc)` - applies right Control to *kc*
  31 * `LALT(kc)` - applies left Alt to *kc*
  32 * `RALT(kc)` - applies right Alt to *kc*
  33 * `LGUI(kc)` - applies left GUI (command/win) to *kc*
  34 * `RGUI(kc)` - applies right GUI (command/win) to *kc*
  35
  36 You can also chain these, like this:
  37
  38     LALT(LCTL(KC_DEL)) -- this makes a key that sends Alt, Control, and Delete in a single keypress.
  39
  40 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`.
  41
  42     KC_TILD  ~
  43     KC_EXLM  !
  44     KC_AT    @
  45     KC_HASH  #
  46     KC_DLR   $
  47     KC_PERC  %
  48     KC_CIRC  ^
  49     KC_AMPR  &
  50     KC_ASTR  *
  51     KC_LPRN  (
  52     KC_RPRN  )
  53     KC_UNDS  _
  54     KC_PLUS  +
  55     KC_LCBR  {
  56     KC_RCBR  }
  57     KC_PIPE  |
  58     KC_COLN  :
  59
  60 `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.
  61
  62 These are the values you can use for the `mod` in `MT()` (right-hand modifiers are not available):
  63
  64   * MOD_LCTL
  65   * MOD_LSFT
  66   * MOD_LALT
  67   * MOD_LGUI
  68
  69 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.
  70
  71 We've added shortcuts to make common modifier/tap (mod-tap) mappings more compact:
  72
  73   * `CTL_T(kc)` - is LCTL when held and *kc* when tapped
  74   * `SFT_T(kc)` - is LSFT when held and *kc* when tapped
  75   * `ALT_T(kc)` - is LALT when held and *kc* when tapped
  76   * `GUI_T(kc)` - is LGUI when held and *kc* when tapped
  77   * `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/)
  78
  79 ### Temporarily setting the default layer
  80
  81 `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.
  82
  83 ### Remember: These are just aliases
  84
  85 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).
  86
  87 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.
  88
  89 ## Macro shortcuts: Send a whole string when pressing just one key
  90
  91 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).
  92
  93 ```c
  94 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.
  95 {
  96   switch(id) {
  97     case 0: // this would trigger when you hit a key mapped as M(0)
  98       if (record->event.pressed) {
  99         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
 100       }
 101       break;
 102   }
 103   return MACRO_NONE;
 104 };
 105 ```
 106 A macro can include the following commands:
 107
 108 * I() change interval of stroke in milliseconds.
 109 * D() press key.
 110 * U() release key.
 111 * T() type key(press and release).
 112 * W() wait (milliseconds).
 113 * END end mark.
 114
 115 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.
 116
 117 Note: Using macros to have your keyboard send passwords for you is a bad idea.
 118
 119 ### Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
 120
 121 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:
 122
 123    #include "keymap_<layout>.h"
 124
 125 Where <layout> is "colemak" or "dvorak". After including this line, you will get access to:
 126
 127  * `CM_*` for all of the Colemak-equivalent characters
 128  * `DV_*` for all of the Dvorak-equivalent characters
 129
 130 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.
 131
 132 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`.
 133
 134 ## Additional language support
 135
 136 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).
 137
 138 ## Unicode support
 139
 140 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.
 141
 142 ## Other firmware shortcut keycodes
 143
 144 * `RESET` - puts the MCU in DFU mode for flashing new firmware (with `make dfu`)
 145 * `DEBUG` - the firmware into debug mode - you'll need hid_listen to see things
 146 * `BL_ON` - turns the backlight on
 147 * `BL_OFF` - turns the backlight off
 148 * `BL_<n>` - sets the backlight to level *n*
 149 * `BL_INC` - increments the backlight level by one
 150 * `BL_DEC` - decrements the backlight level by one
 151 * `BL_TOGG` - toggles the backlight
 152 * `BL_STEP` - steps through the backlight levels
 153
 154 Enable the backlight from the Makefile.
 155
 156 ## MIDI functionalty
 157
 158 This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
 159
 160 ## Bluetooth functionality
 161
 162 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.
 163
 164 ## Building
 165
 166 Download or clone the whole firmware and navigate to the keyboard/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use `make dfu` to program your PCB once you hit the reset button.
 167
 168 Depending on which keymap you would like to use, you will have to compile slightly differently.
 169
 170 ### Default
 171 To build with the default keymap, simply run `make`.
 172
 173 ### Other Keymaps
 174 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.
 175
 176 To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like:
 177 ```
 178 $ make KEYMAP=[default|jack|<name>]
 179 ```
 180 Keymaps follow the format **__keymap\_\<name\>.c__** and are stored in the `keymaps` folder.