README.md

   1 # Quantum Mechanical Keyboard Firmware
   2
   3 [![Build Status](https://travis-ci.org/jackhumbert/qmk_firmware.svg?branch=master)](https://travis-ci.org/jackhumbert/qmk_firmware)
   4
   5 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), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/).
   6
   7 ## Official website
   8
   9 For an easy-to-read version of this document and the repository, check out [http://qmk.fm](http://qmk.fm).
  10
  11 ## Included Keyboards
  12
  13 * [Planck](/keyboards/planck/)
  14 * [Preonic](/keyboards/preonic/)
  15 * [Atomic](/keyboards/atomic/)
  16 * [ErgoDox EZ](/keyboards/ergodox_ez/)
  17 * [Clueboard rev.1](/keyboards/clueboard1/)
  18 * [Clueboard rev.2](/keyboards/clueboard2/)
  19 * [Cluepad](/keyboards/cluepad/)
  20
  21 The project also includes community support for [lots of other keyboards](/keyboards/).
  22
  23 ## Maintainers
  24
  25 QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, TMK. In fact, this repo used to be a fork of TMK, and we are incredibly grateful for his founding contributions to the firmware. We've had to break the fork due to purely technical reasons -- it simply became too different over time, and we've had to start refactoring some of the basic bits and pieces. We are huge fans of TMK, both the firmware and the person. :)
  26
  27 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).
  28
  29 The OLKB product firmwares are maintained by Jack, the Ergodox EZ by Erez, and the Clueboard by [Zach White](https://github.com/skullydazed).
  30
  31 ## Documentation roadmap
  32
  33 This is not a tiny project. While this is the main Readme, there are many other files you might want to consult. Here are some points of interest:
  34
  35 * The Readme for your own keyboard: This is found under `keyboards/<your keyboards's name>/`. So for the ErgoDox EZ, it's [here](keyboards/ergodox_ez/); for the Atomic, it's [here](keyboards/atomic/) and so on.
  36 * The [build guide](doc/BUILD_GUIDE.md), also mentioned in the next section. This is how you put your development environment together so you can compile the firmware.
  37 * The list of possible keycodes you can use in your keymap is actually spread out in a few different places:
  38   * [tmk_core/common/keycode.h](tmk_core/common/keycode.h) - the base TMK keycodes. This is the actual source file.
  39   * [doc/keycode.txt](doc/keycode.txt) - an explanation of those same keycodes.
  40   * [quantum/keymap_common.h](quantum/keymap_common.h) - this is where the QMK-specific aliases are all set up. Things like the Hyper and Meh key, the Leader key, and all of the other QMK innovations. These are also explained and documented below, but `keymap_common.h` is where they're actually defined.
  41 * The [TMK documentation](doc/TMK_README.md). QMK is based on TMK, and this explains how it works internally.
  42
  43 ## Getting started
  44
  45 * [BUILD_GUIDE.md](doc/BUILD_GUIDE.md) contains instructions to set up a build environment, build the firmware, and deploy it to a keyboard. Once your build environment has been set up, all `make` commands to actually build the firmware must be run from a folder in `keyboards/`.
  46 * If you're looking to customize a keyboard that currently runs QMK or TMK, find your keyboard's directory under `keyboards/` and run the make commands from there.
  47 * 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 `util/new_project.sh <project_name>`, which will create `/keyboards/<project_name>` with all the necessary components for a Quantum project.
  48
  49 ### Makefile Options
  50
  51 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.
  52
  53     BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
  54     MIDI_ENABLE = yes      # MIDI controls
  55     UNICODE_ENABLE = no    # <-- This is how you disable an option, just set it to "no"
  56     BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
  57
  58 ### Customizing Makefile options on a per-keymap basis
  59
  60 If your keymap directory has a file called `Makefile` (note the filename), any Makefile options you set in that file will take precedence over other Makefile options (those set for Quantum as a whole or for your particular keyboard).
  61
  62 So let's say your keyboard's makefile has `CONSOLE_ENABLE = yes` (or maybe doesn't even list the `CONSOLE_ENABLE` option, which would cause it to revert to the global Quantum default). You want your particular keymap to not have the debug console, so you make a file called `Makefile` and specify `CONSOLE_ENABLE = no`.
  63
  64 ### Customizing config.h on a per-keymap basis
  65
  66 You can also make a `config.h` file in your keymap directory and use it to override any `config.h` settings you don't like. Anything you set there will take precedence over the global `config.h` for the ErgoDox EZ. To see an example of this, check out `keymaps/erez_experimental`.
  67
  68 ## Quick aliases to common actions
  69
  70 Your keymap can include shortcuts to common operations (called "function actions" in tmk).
  71
  72 ### Switching and toggling layers
  73
  74 `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.
  75
  76 `OSL(layer)` - momentary switch to *layer*, as a one-shot operation. So if you have a key that's defined as `OSL(1)`, and you tap that key, then only the very next keystroke would come from layer 1. You would drop back to layer zero immediately after that one keystroke. That's handy if you have a layer full of custom shortcuts -- for example, a dedicated key for closing a window. So you tap your one-shot layer mod, then tap that magic 'close window' key, and keep typing like a boss. Layer 1 would remain active as long as you hold that key down, too (so you can use it like a momentary toggle-layer key with extra powers).
  77
  78 `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).
  79
  80 `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.
  81
  82
  83 ### Fun with modifier keys
  84
  85 * `LSFT(kc)` - applies left Shift to *kc* (keycode) - `S(kc)` is an alias
  86 * `RSFT(kc)` - applies right Shift to *kc*
  87 * `LCTL(kc)` - applies left Control to *kc*
  88 * `RCTL(kc)` - applies right Control to *kc*
  89 * `LALT(kc)` - applies left Alt to *kc*
  90 * `RALT(kc)` - applies right Alt to *kc*
  91 * `LGUI(kc)` - applies left GUI (command/win) to *kc*
  92 * `RGUI(kc)` - applies right GUI (command/win) to *kc*
  93 * `HYPR(kc)` - applies Hyper (all modifiers) to *kc*
  94 * `MEH(kc)`  - applies Meh (all modifiers except Win/Cmd) to *kc*
  95 * `LCAG(kc)` - applies CtrlAltGui to *kc*
  96
  97 You can also chain these, like this:
  98
  99     LALT(LCTL(KC_DEL)) -- this makes a key that sends Alt, Control, and Delete in a single keypress.
 100
 101 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`.
 102
 103     KC_TILD  ~
 104     KC_EXLM  !
 105     KC_AT    @
 106     KC_HASH  #
 107     KC_DLR   $
 108     KC_PERC  %
 109     KC_CIRC  ^
 110     KC_AMPR  &
 111     KC_ASTR  *
 112     KC_LPRN  (
 113     KC_RPRN  )
 114     KC_UNDS  _
 115     KC_PLUS  +
 116     KC_DQUO  "
 117     KC_LCBR  {
 118     KC_RCBR  }
 119     KC_LABK  <
 120     KC_RABK  >
 121     KC_PIPE  |
 122     KC_COLN  :
 123
 124 `OSM(mod)` - this is a "one shot" modifier. So let's say you have your left Shift key defined as `OSM(MOD_LSFT)`. Tap it, let go, and Shift is "on" -- but only for the next character you'll type. So to write "The", you don't need to hold down Shift -- you tap it, tap t, and move on with life. And if you hold down the left Shift key, it just works as a left Shift key, as you would expect (so you could type THE). There's also a magical, secret way to "lock" a modifier by tapping it multiple times. If you want to learn more about that, open an issue. :)
 125
 126 `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.
 127
 128 These are the values you can use for the `mod` in `MT()` and `OSM()` (right-hand modifiers are not available for `MT()`):
 129
 130   * MOD_LCTL
 131   * MOD_LSFT
 132   * MOD_LALT
 133   * MOD_LGUI
 134   * MOD_HYPR
 135   * MOD_MEH
 136
 137
 138 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.
 139
 140 We've added shortcuts to make common modifier/tap (mod-tap) mappings more compact:
 141
 142   * `CTL_T(kc)` - is LCTL when held and *kc* when tapped
 143   * `SFT_T(kc)` - is LSFT when held and *kc* when tapped
 144   * `ALT_T(kc)` - is LALT when held and *kc* when tapped
 145   * `GUI_T(kc)` - is LGUI when held and *kc* when tapped
 146   * `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/)
 147   * `LCAG_T(kc)` - is CtrlAltGui when held and *kc* when tapped
 148   * `MEH_T(kc)` - is like Hyper, but not as cool -- does not include the Cmd/Win key, so just sends Alt+Ctrl+Shift.
 149
 150 ### Space Cadet Shift: The future, built in
 151
 152 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.
 153
 154 To use it, use `KC_LSPO` (Left Shift, Parens Open) for your left Shift on your keymap, and `KC_RSPC` (Right Shift, Parens Close) for your right Shift.
 155
 156 It's defaulted to work on US keyboards, but if your layout uses different keys for parenthesis, you can define those in your `config.h` like this:
 157
 158     #define LSPO_KEY KC_9
 159     #define RSPC_KEY KC_0
 160
 161 The only other thing you're going to want to do is create a `Makefile` in your keymap directory and set the following:
 162
 163 ```
 164 COMMAND_ENABLE   = no  # Commands for debug and configuration
 165 ```
 166
 167 This is just to keep the keyboard from going into command mode when you hold both Shift keys at the same time.
 168
 169 ### The Leader key: A new kind of modifier
 170
 171 If you've ever used Vim, you know what a Leader key is. If not, you're about to discover a wonderful concept. :) Instead of hitting Alt+Shift+W for example (holding down three keys at the same time), what if you could hit a _sequence_ of keys instead? So you'd hit our special modifier (the Leader key), followed by W and then C (just a rapid succession of keys), and something would happen.
 172
 173 That's what `KC_LEAD` does. Here's an example:
 174
 175 1. Pick a key on your keyboard you want to use as the Leader key. Assign it the keycode `KC_LEAD`. This key would be dedicated just for this -- it's a single action key, can't be used for anything else.
 176 2. Include the line `#define LEADER_TIMEOUT 300` somewhere in your keymap.c file, probably near the top. The 300 there is 300ms -- that's how long you have for the sequence of keys following the leader. You can tweak this value for comfort, of course.
 177 3. Within your `matrix_scan_user` function, do something like this:
 178
 179 ```
 180 void matrix_scan_user(void) {
 181   LEADER_DICTIONARY() {
 182     leading = false;
 183     leader_end();
 184
 185     SEQ_ONE_KEY(KC_F) {
 186       register_code(KC_S);
 187       unregister_code(KC_S);
 188     }
 189     SEQ_TWO_KEYS(KC_A, KC_S) {
 190       register_code(KC_H);
 191       unregister_code(KC_H);
 192     }
 193     SEQ_THREE_KEYS(KC_A, KC_S, KC_D) {
 194       register_code(KC_LGUI);
 195       register_code(KC_S);
 196       unregister_code(KC_S);
 197       unregister_code(KC_LGUI);
 198     }
 199   }
 200 }
 201 ```
 202
 203 As you can see, you have three function. you can use - `SEQ_ONE_KEY` for single-key sequences (Leader followed by just one key), and `SEQ_TWO_KEYS` and `SEQ_THREE_KEYS` for longer sequences. Each of these accepts one or more keycodes as arguments. This is an important point: You can use keycodes from **any layer on your keyboard**. That layer would need to be active for the leader macro to fire, obviously.
 204
 205 ### Temporarily setting the default layer
 206
 207 `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.
 208
 209 ### Prevent stuck modifiers
 210
 211 Consider the following scenario:
 212
 213 1. Layer 0 has a key defined as Shift.
 214 2. The same key is defined on layer 1 as the letter A.
 215 3. User presses Shift.
 216 4. User switches to layer 1 for whatever reason.
 217 5. User releases Shift, or rather the letter A.
 218 6. User switches back to layer 0.
 219
 220 Shift was actually never released and is still considered pressed.
 221
 222 If such situation bothers you add this to your `config.h`:
 223
 224     #define PREVENT_STUCK_MODIFIERS
 225
 226 This option uses 5 bytes of memory per every 8 keys on the keyboard
 227 rounded up (5 bits per key). For example on Planck (48 keys) it uses
 228 (48/8)\*5 = 30 bytes.
 229
 230 ### Remember: These are just aliases
 231
 232 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/doc/keymap.md#2-action).
 233
 234 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.
 235
 236 ## Macro shortcuts: Send a whole string when pressing just one key
 237
 238 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).
 239
 240 ```c
 241 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.
 242 {
 243   switch(id) {
 244     case 0: // this would trigger when you hit a key mapped as M(0)
 245       if (record->event.pressed) {
 246         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
 247       }
 248       break;
 249   }
 250   return MACRO_NONE;
 251 };
 252 ```
 253 A macro can include the following commands:
 254
 255 * I() change interval of stroke in milliseconds.
 256 * D() press key.
 257 * U() release key.
 258 * T() type key(press and release).
 259 * W() wait (milliseconds).
 260 * END end mark.
 261
 262 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.
 263
 264 Note: Using macros to have your keyboard send passwords for you is possible, but a bad idea.
 265
 266 ### Advanced macro functions
 267
 268 To get more control over the keys/actions your keyboard takes, the following functions are available to you in the `action_get_macro` function block:
 269
 270 * `record->event.pressed`
 271
 272 This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
 273
 274 ```c
 275 if (record->event.pressed) {
 276   // on keydown
 277 } else {
 278   // on keyup
 279 }
 280 ```
 281
 282 * `register_code(<kc>);`
 283
 284 This sends the `<kc>` keydown event to the computer. Some examples would be `KC_ESC`, `KC_C`, `KC_4`, and even modifiers such as `KC_LSFT` and `KC_LGUI`.
 285
 286 * `unregister_code(<kc>);`
 287
 288 Parallel to `register_code` function, this sends the `<kc>` keyup event to the computer. If you don't use this, the key will be held down until it's sent.
 289
 290 * `layer_on(<n>);`
 291
 292 This will turn on the layer `<n>` - the higher layer number will always take priority. Make sure you have `KC_TRNS` for the key you're pressing on the layer you're switching to, or you'll get stick there unless you have another plan.
 293
 294 * `layer_off(<n>);`
 295
 296 This will turn off the layer `<n>`.
 297
 298 * `clear_keyboard();`
 299
 300 This will clear all mods and keys currently pressed.
 301
 302 * `clear_mods();`
 303
 304 This will clear all mods currently pressed.
 305
 306 * `clear_keyboard_but_mods();`
 307
 308 This will clear all keys besides the mods currently pressed.
 309
 310 * `update_tri_layer(layer_1, layer_2, layer_3);`
 311
 312 If the user attempts to activate layer 1 AND layer 2 at the same time (for example, by hitting their respective layer keys), layer 3 will be activated. Layers 1 and 2 will _also_ be activated, for the purposes of fallbacks (so a given key will fall back from 3 to 2, to 1 -- and only then to 0).
 313
 314 #### Naming your macros
 315
 316 If you have a bunch of macros you want to refer to from your keymap, while keeping the keymap easily readable, you can just name them like so:
 317
 318 ```
 319 #define AUD_OFF M(6)
 320 #define AUD_ON M(7)
 321 #define MUS_OFF M(8)
 322 #define MUS_ON M(9)
 323 #define VC_IN M(10)
 324 #define VC_DE M(11)
 325 #define PLOVER M(12)
 326 #define EXT_PLV M(13)
 327 ```
 328
 329 As was done on the [Planck default keymap](/keyboards/planck/keymaps/default/keymap.c#L33-L40)
 330
 331 #### Timer functionality
 332
 333 It's possible to start timers and read values for time-specific events - here's an example:
 334
 335 ```c
 336 static uint16_t key_timer;
 337 key_timer = timer_read();
 338 if (timer_elapsed(key_timer) < 100) {
 339   // do something if less than 100ms have passed
 340 } else {
 341   // do something if 100ms or more have passed
 342 }
 343 ```
 344
 345 It's best to declare the `static uint16_t key_timer;` outside of the macro block (top of file, etc).
 346
 347 #### Example: Single-key copy/paste (hold to copy, tap to paste)
 348
 349 With QMK, it's easy to make one key do two things, as long as one of those things is being a modifier. :) So if you want a key to act as Ctrl when held and send the letter R when tapped, that's easy: `CTL_T(KC_R)`. But what do you do when you want that key to send Ctrl-V (paste) when tapped, and Ctrl-C (copy) when held?
 350
 351 Here's what you do:
 352
 353
 354 ```
 355 static uint16_t key_timer;
 356
 357 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
 358 {
 359       switch(id) {
 360         case 0: {
 361             if (record->event.pressed) {
 362                 key_timer = timer_read(); // if the key is being pressed, we start the timer.
 363             }
 364             else { // this means the key was just released, so we can figure out how long it was pressed for (tap or "held down").
 365                 if (timer_elapsed(key_timer) > 150) { // 150 being 150ms, the threshhold we pick for counting something as a tap.
 366                     return MACRO( D(LCTL), T(C), U(LCTL), END  );
 367                 }
 368                 else {
 369                     return MACRO( D(LCTL), T(V), U(LCTL), END  );
 370                 }
 371             }
 372             break;
 373         }
 374       }
 375     return MACRO_NONE;
 376 };
 377 ```
 378
 379 And then, to assign this macro to a key on your keyboard layout, you just use `M(0)` on the key you want to press for copy/paste.
 380
 381 ## Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
 382
 383 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:
 384
 385    #include <keymap_colemak.h>
 386
 387 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:
 388
 389  * `CM_*` for all of the Colemak-equivalent characters
 390  * `DV_*` for all of the Dvorak-equivalent characters
 391
 392 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.
 393
 394 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`.
 395
 396 ## Additional language support
 397
 398 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).
 399
 400 ## Unicode support
 401
 402 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.
 403
 404 ## Other firmware shortcut keycodes
 405
 406 * `RESET` - puts the MCU in DFU mode for flashing new firmware (with `make dfu`)
 407 * `DEBUG` - the firmware into debug mode - you'll need hid_listen to see things
 408 * `BL_ON` - turns the backlight on
 409 * `BL_OFF` - turns the backlight off
 410 * `BL_<n>` - sets the backlight to level *n*
 411 * `BL_INC` - increments the backlight level by one
 412 * `BL_DEC` - decrements the backlight level by one
 413 * `BL_TOGG` - toggles the backlight
 414 * `BL_STEP` - steps through the backlight levels
 415
 416 Enable the backlight from the Makefile.
 417
 418 ## Driving a speaker - audio support
 419
 420 Your keyboard can make sounds! If you've got a Planck, Preonic, or basically any keyboard that allows access to the C6 port, you can hook up a simple speaker and have it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.
 421
 422 The audio code lives in [quantum/audio/audio.h](/quantum/audio/audio.h) and in the other files in the audio directory. It's enabled by default on the Planck [stock keymap](/keyboards/planck/keymaps/default/keymap.c). Here are the important bits:
 423
 424 ```
 425 #include "audio.h"
 426 ```
 427
 428 Then, lower down the file:
 429
 430 ```
 431 float tone_startup[][2] = {
 432     ED_NOTE(_E7 ),
 433     E__NOTE(_CS7),
 434     E__NOTE(_E6 ),
 435     E__NOTE(_A6 ),
 436     M__NOTE(_CS7, 20)
 437 };
 438 ```
 439
 440 This is how you write a song. Each of these lines is a note, so we have a little ditty composed of five notes here.
 441
 442 Then, we have this chunk:
 443
 444 ```
 445 float tone_qwerty[][2]     = SONG(QWERTY_SOUND);
 446 float tone_dvorak[][2]     = SONG(DVORAK_SOUND);
 447 float tone_colemak[][2]    = SONG(COLEMAK_SOUND);
 448 float tone_plover[][2]     = SONG(PLOVER_SOUND);
 449 float tone_plover_gb[][2]  = SONG(PLOVER_GOODBYE_SOUND);
 450
 451 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
 452 float goodbye[][2] = SONG(GOODBYE_SOUND);
 453 ```
 454
 455 Wherein we bind predefined songs (from [audio/song_list.h](/audio/song_list.h)) into named variables. This is one optimization that helps save on memory: These songs only take up memory when you reference them in your keymap, because they're essentially all preprocessor directives.
 456
 457 So now you have something called `tone_plover` for example. How do you make it play the Plover tune, then? If you look further down the keymap, you'll see this:
 458
 459 ```
 460 PLAY_NOTE_ARRAY(tone_plover, false, 0); // Signature is: Song name, repeat, rest style
 461 ```
 462
 463 This is inside one of the macros. So when that macro executes, your keyboard plays that particular chime.
 464
 465 "Rest style" in the method signature above (the last parameter) specifies if there's a rest (a moment of silence) between the notes.
 466
 467 ## MIDI functionalty
 468
 469 This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
 470
 471 ## Bluetooth functionality
 472
 473 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.
 474
 475 ## International Characters on Windows
 476
 477 [AutoHotkey](https://autohotkey.com) allows Windows users to create custom hotkeys among others.
 478
 479 The method does not require Unicode support in the keyboard itself but depends instead of AutoHotkey running in the background.
 480
 481 First you need to select a modifier combination that is not in use by any of your programs.
 482 CtrlAltWin is not used very widely and should therefore be perfect for this.
 483 There is a macro defined for a mod-tab combo `LCAG_T`.
 484 Add this mod-tab combo to a key on your keyboard, e.g.: `LCAG_T(KC_TAB)`.
 485 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.
 486
 487 In the default script of AutoHotkey you can define custom hotkeys.
 488
 489     <^<!<#a::Send, ä
 490     <^<!<#<+a::Send, Ä
 491
 492 The hotkeys above are for the combination CtrlAltGui and CtrlAltGuiShift plus the letter a.
 493 AutoHotkey inserts the Text right of `Send, ` when this combination is pressed.
 494
 495 ## RGB Under Glow Mod
 496
 497 ![Planck with RGB Underglow](https://raw.githubusercontent.com/yangliu/qmk_firmware/planck-rgb/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg)
 498
 499 Here is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY).
 500
 501 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.
 502
 503     RGBLIGHT_ENABLE = yes
 504
 505 Please note that the underglow is not compatible with audio output. So you cannot enable both of them at the same time.
 506
 507 Please add the following options into your config.h, and set them up according your hardware configuration. These settings are for the F4 by default:
 508
 509     #define ws2812_PORTREG  PORTF
 510     #define ws2812_DDRREG   DDRF
 511     #define ws2812_pin PF4
 512     #define RGBLED_NUM 14     // Number of LEDs
 513     #define RGBLIGHT_HUE_STEP 10
 514     #define RGBLIGHT_SAT_STEP 17
 515     #define RGBLIGHT_VAL_STEP 17
 516
 517 You'll need to edit `PORTF`, `DDRF`, and `PF4` on the first three lines to the port/pin you have your LED(s) wired to, eg for B3 change things to:
 518
 519     #define ws2812_PORTREG  PORTB
 520     #define ws2812_DDRREG   DDRB
 521     #define ws2812_pin PB3
 522
 523 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. `keyboards/planck/keymaps/yang/keymap.c`
 524
 525 ### WS2812 Wiring
 526
 527 ![WS2812 Wiring](https://raw.githubusercontent.com/yangliu/qmk_firmware/planck-rgb/keyboards/planck/keymaps/yang/WS2812-wiring.jpg)
 528
 529 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.
 530
 531 ## Safety Considerations
 532
 533 You probably don't want to "brick" your keyboard, making it impossible
 534 to rewrite firmware onto it.  Here are some of the parameters to show
 535 what things are (and likely aren't) too risky.
 536
 537 - If a keyboard map does not include RESET, then, to get into DFU
 538   mode, you will need to press the reset button on the PCB, which
 539   requires unscrewing some bits.
 540 - Messing with tmk_core / common files might make the keyboard
 541   inoperable
 542 - Too large a .hex file is trouble; `make dfu` will erase the block,
 543   test the size (oops, wrong order!), which errors out, failing to
 544   flash the keyboard
 545 - DFU tools do /not/ allow you to write into the bootloader (unless
 546   you throw in extra fruitsalad of options), so there is little risk
 547   there.
 548 - EEPROM has around a 100000 write cycle.  You shouldn't rewrite the
 549   firmware repeatedly and continually; that'll burn the EEPROM
 550   eventually.
 551