3 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/jackhumbert/qmk_firmware/pulls) with your changes!
5 ## Build Environment Setup
9 Due to some issues with the "Windows (Vista and later)" instructions below, we now recommend following these instructions if you use Windows, which will allow you to use the Windows Subsystem for Linux to compile the firmware. If you are not using Windows 10 with the Anniversary Update installed (which came out in July 2016), you will need to use one of the other methods, such as Docker, Vagrant, or the instructions for Vista and later.
11 If you use this method, you will need to use a standalone tool to flash the firmware to the keyboard after you compile it. We recommend the official [QMK Firmware Flasher](https://github.com/jackhumbert/qmk_firmware_flasher/releases). This is because the Windows 10 Subsystem for Linux lacks [libUSB support](https://wpdev.uservoice.com/forums/266908-command-prompt-console-bash-on-ubuntu-on-windo/suggestions/13355724-unable-to-access-usb-devices-from-bash), so it can't access the keyboard's microcontroller. Please add your vote for Microsoft to fix this issue using the link!
15 1. Install the Windows 10 subsystem for Linux, following [these instructions](http://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/).
16 2. If you have cloned the repository using git before August 20, 2016, clean up the line endings from wherever you currently access git:
17 1. Make sure that you have no changes you haven't committed by running `git status`. ANY UNCOMMITTED CHANGES WILL BE PERMANENTLY LOST.
18 2. Run `git rm --cached -r .`
19 3. Run `git reset --hard`
20 3. Open "Bash On Ubuntu On Windows" from the start menu
21 4. With the bash window open, navigate to your copy of the [qmk_firmware repository](https://github.com/jackhumbert/qmk_firmware) using the `cd` command. The harddisks can be accessed from `/mnt/<driveletter>`. For example, your main hard drive (C:) can be accessed by executiing the command `cd /mnt/c`. If your username is John and the qmk_firmware folder is in your Downloads folder, you can move to it with the command `cd /mnt/c/Users/John/Downloads/qmk_firmware`. You can use the Tab key as you go to help you autocomplete the folder names.
22 5. Run `sudo util/install_dependencies.sh`. **This will run `apt-get upgrade`.**
23 6. After a while the installation will finish, and you are good to go
25 **Note** From time to time, the dependencies might change, so just run `install_dependencies.sh` again if things are not working.
27 **Warning:** If you edit Makefiles or shell scripts, make sure you are using an editor that saves the files with Unix line endings. Otherwise the compilation might not work.
30 ### Windows (Vista and later)
31 1. If you have ever installed WinAVR, uninstall it.
32 2. Install [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**.
33 3. If you are going to flash Infinity based keyboards you will need to install dfu-util, refer to the instructions by [Input Club](https://github.com/kiibohd/controller/wiki/Loading-DFU-Firmware).
34 4. Install [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). During installation, uncheck the option to install a graphical user interface. **DO NOT change the default installation folder.** The scripts depend on the default location.
35 5. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/jackhumbert/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer.
36 6. Open the `\util` folder.
37 7. Double-click on the `1-setup-path-win` batch script to run it. You'll need to accept a User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up.
38 8. Right-click on the `2-setup-environment-win` batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete!
40 If you have trouble and want to ask for help, it is useful to generate a *Win_Check_Output.txt* file by running `Win_Check.bat` in the `\util` folder.
43 If you're using [homebrew,](http://brew.sh/) you can use the following commands:
45 brew tap osx-cross/avr
47 brew install dfu-programmer
49 This is the recommended method. If you don't have homebrew, [install it!](http://brew.sh/) It's very much worth it for anyone who works in the command line.
51 You can also try these instructions:
53 1. Install Xcode from the App Store.
54 2. Install the Command Line Tools from `Xcode->Preferences->Downloads`.
55 3. Install [DFU-Programmer](https://dfu-programmer.github.io/).
57 If you are going to flash Infinity based keyboards you will also need dfu-util
63 To ensure you are always up to date, you can just run `sudo util/install_dependencies.sh`. That should always install all the dependencies needed. **This will run `apt-get upgrade`.**
65 You can also install things manually, but this documentation might not be always up to date with all requirements.
67 The current requirements are the following, but not all might be needed depending on what you do. Also note that some systems might not have all the dependencies available as packages, or they might be named differently.
81 binutils-arm-none-eabi
82 libnewlib-arm-none-eabi
86 Install the dependencies with your favorite package manager.
88 Debian/Ubuntu example:
91 sudo apt-get install gcc unzip wget zip gcc-avr binutils-avr avr-libc dfu-programmer dfu-util gcc-arm-none-eabi binutils-arm-none-eabi libnewlib-arm-none-eabi
95 If this is a bit complex for you, Docker might be the turn-key solution you need. After installing [Docker](https://www.docker.com/products/docker), run the following command at the root of the QMK folder to build a keyboard/keymap:
98 # You'll run this every time you want to build a keymap
99 # modify the keymap and keyboard assigment to compile what you want
100 # defaults are ergodox/default
102 docker run -e keymap=gwen -e subproject=ez -e keyboard=ergodox --rm -v $('pwd'):/qmk:rw edasque/qmk_firmware
104 # On windows docker seems to have issue with VOLUME tag in Dockerfile, and $('pwd') won't print a windows compliant path, use full path instead like this
105 docker run -e keymap=default -e subproject=ez -e keyboard=ergobox --rm -v D:/Users/Sacapuces/Documents/Repositories/qmk:/qmk:rw edasque/qmk_firmware
109 This will compile the targetted keyboard/keymap and leave it in your QMK directory for you to flash.
112 If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [VAGRANT_GUIDE file](doc/VAGRANT_GUIDE.md).
114 ## Verify Your Installation
115 1. If you haven't already, obtain this repository ([https://github.com/jackhumbert/qmk_firmware](https://github.com/jackhumbert/qmk_firmware)). You can either download it as a zip file and extract it, or clone it using the command line tool git or the Github Desktop application.
116 2. Open up a terminal or command prompt and navigate to the `qmk_firmware` folder using the `cd` command. The command prompt will typically open to your home directory. If, for example, you cloned the repository to your Documents folder, then you would type `cd Documents/qmk_firmware`. If you extracted the file from a zip, then it may be named `qmk_firmware-master` instead.
117 3. To confirm that you're in the correct location, you can display the contents of your current folder using the `dir` command on Windows, or the `ls` command on Linux or Mac. You should see several files, including `readme.md` and a `quantum` folder. From here, you need to navigate to the appropriate folder under `keyboards/`. For example, if you're building for a Planck, run `cd keyboards/planck`.
118 4. Once you're in the correct keyboard-specific folder, run the `make` command. This should output a lot of information about the build process. More information about the `make` command can be found below.
120 # Customizing your keymap
122 In every keymap folder, the following files are recommended:
124 * `config.h` - the options to configure your keymap
125 * `keymap.c` - all of your keymap code, required
126 * `Makefile` - the features of QMK that are enabled, required to run `make` in your keymap folder
127 * `readme.md` - a description of your keymap, how others might use it, and explanations of features
129 ## The `make` command
131 The `make` command is how you compile the firmware into a .hex file, which can be loaded by a dfu programmer (like dfu-progammer via `make dfu`) or the [Teensy loader](https://www.pjrc.com/teensy/loader.html) (only used with Teensys).
133 **NOTE:** To abort a make command press `Ctrl-c`
135 The following instruction refers to these folders.
137 * The `root` (`/`) folder is the qmk_firmware folder, in which are `doc`, `keyboard`, `quantum`, etc.
138 * The `keyboard` folder is any keyboard project's folder, like `/keyboards/planck`.
139 * The `keymap` folder is any keymap's folder, like `/keyboards/planck/keymaps/default`.
140 * The `subproject` folder is the subproject folder of a keyboard, like `/keyboards/ergodox/ez`
142 ### Simple instructions for building and uploading a keyboard
144 **Most keyboards have more specific instructions in the keyboard specific readme.md file, so please check that first**
146 If the `keymap` folder contains a file name `Makefile`
148 1. Change the directory to the `keymap` folder
149 2. Run `make <subproject>-<programmer>`
151 Otherwise, if there's no `Makefile` in the `keymap` folder
153 1. Enter the `keyboard` folder
154 2. Run `make <subproject>-<keymap>-<programmer>`
156 In the above commands, replace:
158 * `<keymap>` with the name of your keymap
159 * `<subproject>` with the name of the subproject (revision or sub-model of your keyboard). For example, for Ergodox it can be `ez` or `infinity`, and for Planck `rev3` or `rev4`.
160 * If the keyboard doesn't have a subproject, or if you are happy with the default (defined in `rules.mk` file of the `keyboard` folder), you can leave it out. But remember to also remove the dash (`-`) from the command.
161 * `<programmer>` The programmer to use. Most keyboards use `dfu`, but some use `teensy`. Infinity keyboards use `dfu-util`. Check the readme file in the keyboard folder to find out which programmer to use.
162 * If you don't add `-<programmer` to the command line, the firmware will be still be compiled into a hex file, but the upload will be skipped.
164 **NOTE:** Some operating systems will refuse to program unless you run the make command as root for example `sudo make dfu`
166 ### More detailed make instruction
168 The full syntax of the `make` command is the following, but parts of the command can be left out if you run it from other directories than the `root` (as you might already have noticed by reading the simple instructions).
170 `<keyboard>-<subproject>-<keymap>-<target>`, where:
172 * `<keyboard>` is the name of the keyboard, for example `planck`
173 * Use `allkb` to compile all keyboards
174 * `<subproject>` is the name of the subproject (revision or sub-model of the keyboard). For example, for Ergodox it can be `ez` or `infinity`, and for Planck `rev3` or `rev4`.
175 * If the keyboard doesn't have any subprojects, it can be left out
176 * To compile the default subproject, you can leave it out, or specify `defaultsp`
177 * Use `allsp` to compile all subprojects
178 * `<keymap>` is the name of the keymap, for example `algernon`
179 * Use `allkm` to compile all keymaps
180 * `<target>` will be explained in more detail below.
182 **Note:** When you leave some parts of the command out, you should also remove the dash (`-`).
184 As mentioned above, there are some shortcuts, when you are in a:
186 * `keyboard` folder, the command will automatically fill the `<keyboard>` part. So you only need to type `<subproject>-<keymap>-<target>`
187 * `subproject` folder, it will fill in both `<keyboard>` and `<subproject>`
188 * `keymap` folder, then `<keyboard>` and `<keymap>` will be filled in. If you need to specify the `<subproject>` use the following syntax `<subproject>-<target>`
189 * Note in order to support this shortcut, the keymap needs its own Makefile (see the example [here](/doc/keymap_makefile_example.mk))
190 * `keymap` folder of a `subproject`, then everything except the `<target>` will be filled in
192 The `<target>` means the following
193 * If no target is given, then it's the same as `all` below
194 * `all` compiles the keyboard and generates a `<keyboard>_<keymap>.hex` file in whichever folder you run `make` from. These files are ignored by git, so don't worry about deleting them when committing/creating pull requests.
195 * `dfu`, `teensy` or `dfu-util`, compile and upload the firmware to the keyboard. If the compilation fails, then nothing will be uploaded. The programmer to use depends on the keyboard. For most keyboards it's `dfu`, but for Infinity keyboards you should use `dfu-util`, and `teensy` for standard Teensys. To find out which command you should use for your keyboard, check the keyboard specific readme. **Note** that some operating systems needs root access for these commands to work, so in that case you need to run for example `sudo make dfu`.
196 * `clean`, cleans the build output folders to make sure that everything is built from scratch. Run this before normal compilation if you have some unexplainable problems.
198 Some other targets are supported but, but not important enough to be documented here. Check the source code of the make files for more information.
200 You can also add extra options at the end of the make command line, after the target
202 * `make COLOR=false` - turns off color output
203 * `make SILENT=true` - turns off output besides errors/warnings
204 * `make VERBOSE=true` - outputs all of the gcc stuff (not interesting, unless you need to debug)
205 * `make EXTRAFLAGS=-E` - Preprocess the code without doing any compiling (useful if you are trying to debug #define commands)
207 The make command itself also has some additional options, type `make --help` for more information. The most useful is probably `-jx`, which specifies that you want to compile using more than one CPU, the `x` represents the number of CPUs that you want to use. Setting that can greatly reduce the compile times, especially if you are compiling many keyboards/keymaps. I usually set it to one less than the number of CPUs that I have, so that I have some left for doing other things while it's compiling. Note that not all operating systems and make versions supports that option.
209 Here are some examples commands
211 * `make allkb-allsp-allkm` builds everything (all keyboards, all subprojects, all keymaps). Running just `make` from the `root` will also run this.
212 * `make` from within a `keyboard` directory, is the same as `make keyboard-allsp-allkm`, which compiles all subprojects and keymaps of the keyboard. **NOTE** that this behaviour has changed. Previously it compiled just the default keymap.
213 * `make ergodox-infinity-algernon-clean` will clean the build output of the Ergodox Infinity keyboard. This example uses the full syntax and can be run from any folder with a `Makefile`
214 * `make dfu COLOR=false` from within a keymap folder, builds and uploads the keymap, but without color output.
218 There are 5 different `make` and `Makefile` locations:
221 * keyboard (`/keyboards/<keyboard>/`)
222 * keymap (`/keyboards/<keyboard>/keymaps/<keymap>/`)
223 * subproject (`/keyboards/<keyboard>/<subproject>`)
224 * subproject keymap (`/keyboards/<keyboard>/<subproject>/keymaps/<keymap>`)
226 The root contains the code used to automatically figure out which keymap or keymaps to compile based on your current directory and commandline arguments. It's considered stable, and shouldn't be modified. The keyboard one will contain the MCU set-up and default settings for your keyboard, and shouldn't be modified unless you are the producer of that keyboard. The keymap Makefile can be modified by users, and is optional. It is included automatically if it exists. You can see an example [here](/doc/keymap_makefile_example.mk) - the last few lines are the most important. The settings you set here will override any defaults set in the keyboard Makefile. **The file is required if you want to run `make` in the keymap folder.**
228 For keyboards and subprojects, the make files are split in two parts `Makefile` and `rules.mk`. All settings can be found in the `rules.mk` file, while the `Makefile` is just there for support and including the root `Makefile`. Keymaps contain just one `Makefile` for simplicity.
232 Set these variables to `no` to disable them, and `yes` to enable them.
236 This allows you to hold a key and the salt key (space by default) and have access to a various EEPROM settings that persist over power loss. It's advised you keep this disabled, as the settings are often changed by accident, and produce confusing results that makes it difficult to debug. It's one of the more common problems encountered in help sessions.
238 Consumes about 1000 bytes.
242 This gives you control over cursor movements and clicks via keycodes/custom functions.
246 This allows you to use the system and audio control key codes.
250 This allows you to print messages that can be read using [`hid_listen`](https://www.pjrc.com/teensy/hid_listen.html).
252 By default, all debug (*dprint*) print (*print*, *xprintf*), and user print (*uprint*) messages will be enabled. This will eat up a significant portion of the flash and may make the keyboard .hex file too big to program.
254 To disable debug messages (*dprint*) and reduce the .hex file size, include `#define NO_DEBUG` in your `config.h` file.
256 To disable print messages (*print*, *xprintf*) and user print messages (*uprint*) and reduce the .hex file size, include `#define NO_PRINT` in your `config.h` file.
258 To disable print messages (*print*, *xprintf*) and **KEEP** user print messages (*uprint*), include `#define USER_PRINT` in your `config.h` file.
260 To see the text, open `hid_listen` and enjoy looking at your printed messages.
262 **NOTE:** Do not include *uprint* messages in anything other than your keymap code. It must not be used within the QMK system framework. Otherwise, you will bloat other people's .hex files.
264 Consumes about 400 bytes.
268 This enables magic commands, typically fired with the default magic key combo `LSHIFT+RSHIFT+KEY`. Magic commands include turning on debugging messages (`MAGIC+D`) or temporarily toggling NKRO (`MAGIC+N`).
272 Enables your LED to breath while your computer is sleeping. Timer1 is being used here. This feature is largely unused and untested, and needs updating/abstracting.
276 This allows the keyboard to tell the host OS that up to 248 keys are held down at once (default without NKRO is 6). NKRO is off by default, even if `NKRO_ENABLE` is set. NKRO can be forced by adding `#define FORCE_NKRO` to your config.h or by binding `MAGIC_TOGGLE_NKRO` to a key and then hitting the key.
280 This enables your backlight on Timer1 and ports B5, B6, or B7 (for now). You can specify your port by putting this in your `config.h`:
282 #define BACKLIGHT_PIN B7
286 This enables MIDI sending and receiving with your keyboard. To enter MIDI send mode, you can use the keycode `MI_ON`, and `MI_OFF` to turn it off. This is a largely untested feature, but more information can be found in the `quantum/quantum.c` file.
290 This allows you to send unicode symbols via `UC(<unicode>)` in your keymap. Only codes up to 0x7FFF are currently supported.
294 This allows sending unicode symbols using `X(<unicode>)` in your keymap. Codes
295 up to 0xFFFFFFFF are supported, including emojis. You will need to maintain
296 a separate mapping table in your keymap file.
299 - Under Mac OS, only codes up to 0xFFFF are supported.
300 - Under Linux ibus, only codes up to 0xFFFFF are supported (but anything important is still under this limit for now).
302 Characters out of range supported by the OS will be ignored.
306 This allows you to interface with a Bluefruit EZ-key to send keycodes wirelessly. It uses the D2 and D3 pins.
310 This allows you output audio on the C6 pin (needs abstracting). See the [audio section](#audio-output-from-a-speaker) for more information.
314 Uses buzzer to emulate clicky switches. A cheap imitation of the Cherry blue switches. By default, uses the C6 pin, same as AUDIO_ENABLE.
318 Use this to debug changes to variable values, see the [tracing variables](#tracing-variables) section for more information.
322 This enables using the Quantum SYSEX API to send strings (somewhere?)
324 This consumes about 5390 bytes.
326 ### Customizing Makefile options on a per-keymap basis
328 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 for your particular keyboard.
330 So let's say your keyboard's makefile has `BACKLIGHT_ENABLE = yes` (or maybe doesn't even list the `BACKLIGHT_ENABLE` option, which would cause it to be off). You want your particular keymap to not have the debug console, so you make a file called `Makefile` and specify `BACKLIGHT_ENABLE = no`.
332 You can use the `doc/keymap_makefile_example.md` as a template/starting point.
334 ## The `config.h` file
336 There are 2 `config.h` locations:
338 * keyboard (`/keyboards/<keyboard>/`)
339 * keymap (`/keyboards/<keyboard>/keymaps/<keymap>/`)
341 The keyboard `config.h` is included only if the keymap one doesn't exist. The format to use for your custom one [is here](/doc/keymap_config_h_example.h). If you want to override a setting from the parent `config.h` file, you need to do this:
348 For a value of `4` for this imaginary setting. So we `undef` it first, then `define` it.
350 You can then override any settings, rather than having to copy and paste the whole thing.
352 # Going beyond the keycodes
354 Aside from the [basic keycodes](https://github.com/jackhumbert/qmk_firmware/blob/master/doc/keycode.txt), your keymap can include shortcuts to common operations.
356 ## Quick aliases to common actions
358 Your keymap can include shortcuts to common operations (called "function actions" in tmk).
360 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).
362 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.
364 ### Switching and toggling layers
366 `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.
368 `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).
370 `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).
372 `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.
374 `TO(layer)` - Goes to a layer. This code is special, because it lets you go either up or down the stack -- just goes directly to the layer you want. So while other codes only let you go _up_ the stack (from layer 0 to layer 3, for example), `TO(2)` is going to get you to layer 2, no matter where you activate it from -- even if you're currently on layer 5. This gets activated on keydown (as soon as the key is pressed).
377 ### Fun with modifier keys
379 * `LSFT(kc)` - applies left Shift to *kc* (keycode) - `S(kc)` is an alias
380 * `RSFT(kc)` - applies right Shift to *kc*
381 * `LCTL(kc)` - applies left Control to *kc*
382 * `RCTL(kc)` - applies right Control to *kc*
383 * `LALT(kc)` - applies left Alt to *kc*
384 * `RALT(kc)` - applies right Alt to *kc*
385 * `LGUI(kc)` - applies left GUI (command/win) to *kc*
386 * `RGUI(kc)` - applies right GUI (command/win) to *kc*
387 * `HYPR(kc)` - applies Hyper (all modifiers) to *kc*
388 * `MEH(kc)` - applies Meh (all modifiers except Win/Cmd) to *kc*
389 * `LCAG(kc)` - applies CtrlAltGui to *kc*
391 You can also chain these, like this:
393 LALT(LCTL(KC_DEL)) -- this makes a key that sends Alt, Control, and Delete in a single keypress.
395 The following shortcuts automatically add `LSFT()` to keycodes to get commonly used symbols. Their long names are also available and documented in `quantum/quantum_keycodes.h`.
419 `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. :)
421 `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.
423 These are the values you can use for the `mod` in `MT()` and `OSM()` (right-hand modifiers are not available for `MT()`):
432 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.
434 We've added shortcuts to make common modifier/tap (mod-tap) mappings more compact:
436 * `CTL_T(kc)` - is LCTL when held and *kc* when tapped
437 * `SFT_T(kc)` - is LSFT when held and *kc* when tapped
438 * `ALT_T(kc)` - is LALT when held and *kc* when tapped
439 * `GUI_T(kc)` - is LGUI when held and *kc* when tapped
440 * `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/)
441 * `LCAG_T(kc)` - is CtrlAltGui when held and *kc* when tapped
442 * `MEH_T(kc)` - is like Hyper, but not as cool -- does not include the Cmd/Win key, so just sends Alt+Ctrl+Shift.
444 ## Space Cadet Shift: The future, built in
446 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.
448 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.
450 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:
452 #define LSPO_KEY KC_9
453 #define RSPC_KEY KC_0
455 You can also choose between different rollover behaviors of the shift keys by defining:
457 #define DISABLE_SPACE_CADET_ROLLOVER
459 in your `config.h`. Disabling rollover allows you to use the opposite shift key to cancel the space cadet state in the event of an erroneous press instead of emitting a pair of parentheses when the keys are released.
461 The only other thing you're going to want to do is create a `Makefile` in your keymap directory and set the following:
464 COMMAND_ENABLE = no # Commands for debug and configuration
467 This is just to keep the keyboard from going into command mode when you hold both Shift keys at the same time.
469 ## The Leader key: A new kind of modifier
471 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.
473 That's what `KC_LEAD` does. Here's an example:
475 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.
476 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.
477 3. Within your `matrix_scan_user` function, do something like this:
482 void matrix_scan_user(void) {
483 LEADER_DICTIONARY() {
489 unregister_code(KC_S);
491 SEQ_TWO_KEYS(KC_A, KC_S) {
493 unregister_code(KC_H);
495 SEQ_THREE_KEYS(KC_A, KC_S, KC_D) {
496 register_code(KC_LGUI);
498 unregister_code(KC_S);
499 unregister_code(KC_LGUI);
505 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.
507 ## Tap Dance: A single key can do 3, 5, or 100 different things
509 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. It's one of the nicest community-contributed features in the firmware, conceived and created by [algernon](https://github.com/algernon) in [#451](https://github.com/jackhumbert/qmk_firmware/pull/451). Here's how algernon describes the feature:
511 With this feature one can specify keys that behave differently, based on the amount of times they have been tapped, and when interrupted, they get handled before the interrupter.
513 To make it clear how this is different from `ACTION_FUNCTION_TAP`, lets explore a certain setup! We want one key to send `Space` on single tap, but `Enter` on double-tap.
515 With `ACTION_FUNCTION_TAP`, it is quite a rain-dance to set this up, and has the problem that when the sequence is interrupted, the interrupting key will be send first. Thus, `SPC a` will result in `a SPC` being sent, if they are typed within `TAPPING_TERM`. With the tap dance feature, that'll come out as `SPC a`, correctly.
517 The implementation hooks into two parts of the system, to achieve this: into `process_record_quantum()`, and the matrix scan. We need the latter to be able to time out a tap sequence even when a key is not being pressed, so `SPC` alone will time out and register after `TAPPING_TERM` time.
519 But lets start with how to use it, first!
521 First, you will need `TAP_DANCE_ENABLE=yes` in your `Makefile`, because the feature is disabled by default. This adds a little less than 1k to the firmware size. Next, you will want to define some tap-dance keys, which is easiest to do with the `TD()` macro, that - similar to `F()`, takes a number, which will later be used as an index into the `tap_dance_actions` array.
523 This array specifies what actions shall be taken when a tap-dance key is in action. Currently, there are three possible options:
525 * `ACTION_TAP_DANCE_DOUBLE(kc1, kc2)`: Sends the `kc1` keycode when tapped once, `kc2` otherwise. When the key is held, the appropriate keycode is registered: `kc1` when pressed and held, `kc2` when tapped once, then pressed and held.
526 * `ACTION_TAP_DANCE_FN(fn)`: Calls the specified function - defined in the user keymap - with the final tap count of the tap dance action.
527 * `ACTION_TAP_DANCE_FN_ADVANCED(on_each_tap_fn, on_dance_finished_fn, on_dance_reset_fn)`: Calls the first specified function - defined in the user keymap - on every tap, the second function on when the dance action finishes (like the previous option), and the last function when the tap dance action resets.
529 The first option is enough for a lot of cases, that just want dual roles. For example, `ACTION_TAP_DANCE(KC_SPC, KC_ENT)` will result in `Space` being sent on single-tap, `Enter` otherwise.
531 And that's the bulk of it!
533 And now, on to the explanation of how it works!
535 The main entry point is `process_tap_dance()`, called from `process_record_quantum()`, which is run for every keypress, and our handler gets to run early. This function checks whether the key pressed is a tap-dance key. If it is not, and a tap-dance was in action, we handle that first, and enqueue the newly pressed key. If it is a tap-dance key, then we check if it is the same as the already active one (if there's one active, that is). If it is not, we fire off the old one first, then register the new one. If it was the same, we increment the counter and the timer.
537 This means that you have `TAPPING_TERM` time to tap the key again, you do not have to input all the taps within that timeframe. This allows for longer tap counts, with minimal impact on responsiveness.
539 Our next stop is `matrix_scan_tap_dance()`. This handles the timeout of tap-dance keys.
541 For the sake of flexibility, tap-dance actions can be either a pair of keycodes, or a user function. The latter allows one to handle higher tap counts, or do extra things, like blink the LEDs, fiddle with the backlighting, and so on. This is accomplished by using an union, and some clever macros.
545 Here's a simple example for a single definition:
547 1. In your `makefile`, add `TAP_DANCE_ENABLE = yes`
548 2. In your `config.h` (which you can copy from `qmk_firmware/keyboards/planck/config.h` to your keymap directory), add `#define TAPPING_TERM 200`
549 3. In your `keymap.c` file, define the variables and definitions, then add to your keymap:
552 //Tap Dance Declarations
557 //Tap Dance Definitions
558 qk_tap_dance_action_t tap_dance_actions[] = {
559 //Tap once for Esc, twice for Caps Lock
560 [TD_ESC_CAPS] = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_CAPS)
561 // Other declarations would go here, separated by commas, if you have them
564 //In Layer declaration, add tap dance item in place of a key code
568 Here's a more complex example involving custom actions:
578 /* Have the above three on the keymap, TD(CT_SE), etc... */
580 void dance_cln_finished (qk_tap_dance_state_t *state, void *user_data) {
581 if (state->count == 1) {
582 register_code (KC_RSFT);
583 register_code (KC_SCLN);
585 register_code (KC_SCLN);
589 void dance_cln_reset (qk_tap_dance_state_t *state, void *user_data) {
590 if (state->count == 1) {
591 unregister_code (KC_RSFT);
592 unregister_code (KC_SCLN);
594 unregister_code (KC_SCLN);
598 void dance_egg (qk_tap_dance_state_t *state, void *user_data) {
599 if (state->count >= 100) {
600 SEND_STRING ("Safety dance!");
601 reset_tap_dance (state);
605 // on each tap, light up one led, from right to left
606 // on the forth tap, turn them off from right to left
607 void dance_flsh_each(qk_tap_dance_state_t *state, void *user_data) {
608 switch (state->count) {
610 ergodox_right_led_3_on();
613 ergodox_right_led_2_on();
616 ergodox_right_led_1_on();
619 ergodox_right_led_3_off();
621 ergodox_right_led_2_off();
623 ergodox_right_led_1_off();
627 // on the fourth tap, set the keyboard on flash state
628 void dance_flsh_finished(qk_tap_dance_state_t *state, void *user_data) {
629 if (state->count >= 4) {
631 reset_tap_dance(state);
635 // if the flash state didnt happen, then turn off leds, left to right
636 void dance_flsh_reset(qk_tap_dance_state_t *state, void *user_data) {
637 ergodox_right_led_1_off();
639 ergodox_right_led_2_off();
641 ergodox_right_led_3_off();
644 qk_tap_dance_action_t tap_dance_actions[] = {
645 [CT_SE] = ACTION_TAP_DANCE_DOUBLE (KC_SPC, KC_ENT)
646 ,[CT_CLN] = ACTION_TAP_DANCE_FN_ADVANCED (NULL, dance_cln_finished, dance_cln_reset)
647 ,[CT_EGG] = ACTION_TAP_DANCE_FN (dance_egg)
648 ,[CT_FLSH] = ACTION_TAP_DANCE_FN_ADVANCED (dance_flsh_each, dance_flsh_finished, dance_flsh_reset)
652 ## Temporarily setting the default layer
654 `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.
656 ## Prevent stuck modifiers
658 Consider the following scenario:
660 1. Layer 0 has a key defined as Shift.
661 2. The same key is defined on layer 1 as the letter A.
662 3. User presses Shift.
663 4. User switches to layer 1 for whatever reason.
664 5. User releases Shift, or rather the letter A.
665 6. User switches back to layer 0.
667 Shift was actually never released and is still considered pressed.
669 If such situation bothers you add this to your `config.h`:
671 #define PREVENT_STUCK_MODIFIERS
673 This option uses 5 bytes of memory per every 8 keys on the keyboard
674 rounded up (5 bits per key). For example on Planck (48 keys) it uses
675 (48/8)\*5 = 30 bytes.
677 ## Macro shortcuts: Send a whole string when pressing just one key
679 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).
682 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.
685 case 0: // this would trigger when you hit a key mapped as M(0)
686 if (record->event.pressed) {
687 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
694 A macro can include the following commands:
696 * I() change interval of stroke in milliseconds.
699 * T() type key(press and release).
700 * W() wait (milliseconds).
703 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.
705 Note: Using macros to have your keyboard send passwords for you is possible, but a bad idea.
707 ### Advanced macro functions
709 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:
711 * `record->event.pressed`
713 This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
716 if (record->event.pressed) {
723 * `register_code(<kc>);`
725 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`.
727 * `unregister_code(<kc>);`
729 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.
733 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.
737 This will turn off the layer `<n>`.
739 * `clear_keyboard();`
741 This will clear all mods and keys currently pressed.
745 This will clear all mods currently pressed.
747 * `clear_keyboard_but_mods();`
749 This will clear all keys besides the mods currently pressed.
751 * `update_tri_layer(layer_1, layer_2, layer_3);`
753 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).
755 #### Naming your macros
757 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:
767 #define EXT_PLV M(13)
770 As was done on the [Planck default keymap](/keyboards/planck/keymaps/default/keymap.c#L33-L40)
772 #### Timer functionality
774 It's possible to start timers and read values for time-specific events - here's an example:
777 static uint16_t key_timer;
778 key_timer = timer_read();
779 if (timer_elapsed(key_timer) < 100) {
780 // do something if less than 100ms have passed
782 // do something if 100ms or more have passed
786 It's best to declare the `static uint16_t key_timer;` outside of the macro block (top of file, etc).
788 #### Example: Single-key copy/paste (hold to copy, tap to paste)
790 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?
796 static uint16_t key_timer;
798 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
802 if (record->event.pressed) {
803 key_timer = timer_read(); // if the key is being pressed, we start the timer.
805 else { // this means the key was just released, so we can figure out how long it was pressed for (tap or "held down").
806 if (timer_elapsed(key_timer) > 150) { // 150 being 150ms, the threshhold we pick for counting something as a tap.
807 return MACRO( D(LCTL), T(C), U(LCTL), END );
810 return MACRO( D(LCTL), T(V), U(LCTL), END );
820 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.
822 ## Dynamic macros: record and replay macros in runtime
824 In addition to the static macros described above, you may enable the dynamic macros which you may record while writing. They are forgotten as soon as the keyboard is unplugged. Only two such macros may be stored at the same time, with the total length of 64 keypresses (by default).
826 To enable them, first add a new element to the `planck_keycodes` enum -- `DYNAMIC_MACRO_RANGE`:
828 enum planck_keycodes {
840 Afterwards create a new layer called `_DYN`:
842 #define _DYN 6 /* almost any other free number should be ok */
844 Below these two modifications include the `dynamic_macro.h` header:
846 #include "dynamic_macro.h"`
848 Then define the `_DYN` layer with the following keys: `DYN_REC_START1`, `DYN_MACRO_PLAY1`,`DYN_REC_START2` and `DYN_MACRO_PLAY2`. It may also contain other keys, it doesn't matter apart from the fact that you won't be able to record these keys in the dynamic macros.
851 {_______, DYN_REC_START1, DYN_MACRO_PLAY1, _______, _______, _______, _______, _______, _______, _______, _______, _______},
852 {_______, DYN_REC_START2, DYN_MACRO_PLAY2, _______, _______, _______, _______, _______, _______, _______, _______, _______},
853 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
854 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
857 Add the following code to the very beginning of your `process_record_user()` function:
859 if (!process_record_dynamic_macro(keycode, record)) {
863 To start recording the macro, press either `DYN_REC_START1` or `DYN_REC_START2`. To finish the recording, press the `_DYN` layer button. The handler awaits specifically for the `MO(_DYN)` keycode as the "stop signal" so please don't use any fancy ways to access this layer, use the regular `MO()` modifier. To replay the macro, press either `DYN_MACRO_PLAY1` or `DYN_MACRO_PLAY2`.
865 If the LED-s start blinking during the recording with each keypress, it means there is no more space for the macro in the macro buffer. To fit the macro in, either make the other macro shorter (they share the same buffer) or increase the buffer size by setting the `DYNAMIC_MACRO_SIZE` preprocessor macro (default value: 128; please read the comments for it in the header).
867 For the details about the internals of the dynamic macros, please read the comments in the `dynamic_macro.h` header.
869 ## Additional keycode aliases for software-implemented layouts (Colemak, Dvorak, etc)
871 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:
873 #include <keymap_colemak.h>
875 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:
877 * `CM_*` for all of the Colemak-equivalent characters
878 * `DV_*` for all of the Dvorak-equivalent characters
880 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.
882 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`.
884 ## Additional language support
886 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).
890 There are three Unicode keymap definition method available in QMK:
894 Supports Unicode input up to 0xFFFF. The keycode function is `UC(n)` in
895 keymap file, where *n* is a 4 digit hexadecimal.
897 ### UNICODEMAP_ENABLE
899 Supports Unicode up to 0xFFFFFFFF. You need to maintain a separate mapping
900 table `const uint32_t PROGMEM unicode_map[] = {...}` in your keymap file.
901 The keycode function is `X(n)` where *n* is the array index of the mapping
908 Unicode input in QMK works by inputing a sequence of characters to the OS,
909 sort of like macro. Unfortunately, each OS has different ideas on how Unicode is inputted.
911 This is the current list of Unicode input method in QMK:
913 * UC_OSX: MacOS Unicode Hex Input support. Works only up to 0xFFFF. Disabled by default. To enable: go to System Preferences -> Keyboard -> Input Sources, and enable Unicode Hex.
914 * UC_LNX: Unicode input method under Linux. Works up to 0xFFFFF. Should work almost anywhere on ibus enabled distros. Without ibus, this works under GTK apps, but rarely anywhere else.
915 * UC_WIN: (not recommended) Windows built-in Unicode input. To enable: create registry key under `HKEY_CURRENT_USER\Control Panel\Input Method\EnableHexNumpad` of type `REG_SZ` called `EnableHexNumpad`, set its value to 1, and reboot. This method is not recommended because of reliability and compatibility issue, use WinCompose method below instead.
916 * UC_WINC: Windows Unicode input using WinCompose. Requires [WinCompose](https://github.com/samhocevar/wincompose). Works reliably under many (all?) variations of Windows.
918 ## Backlight Breathing
920 In order to enable backlight breathing, the following line must be added to your config.h file.
922 #define BACKLIGHT_BREATHING
924 The following function calls are used to control the breathing effect.
926 * ```breathing_enable()``` - Enable the free-running breathing effect.
927 * ```breathing_disable()``` - Disable the free-running breathing effect immediately.
928 * ```breathing_self_disable()``` - Disable the free-running breathing effect after the current effect ends.
929 * ```breathing_toggle()``` - Toggle the free-running breathing effect.
930 * ```breathing_defaults()``` - Reset the speed and brightness settings of the breathing effect.
932 The following function calls are used to control the maximum brightness of the breathing effect.
934 * ```breathing_intensity_set(value)``` - Set the brightness of the breathing effect when it is at its max value.
935 * ```breathing_intensity_default()``` - Reset the brightness of the breathing effect to the default value based on the current backlight intensity.
937 The following function calls are used to control the cycling speed of the breathing effect.
939 * ```breathing_speed_set(value)``` - Set the speed of the breathing effect - how fast it cycles.
940 * ```breathing_speed_inc(value)``` - Increase the speed of the breathing effect by a fixed value.
941 * ```breathing_speed_dec(value)``` - Decrease the speed of the breathing effect by a fixed value.
942 * ```breathing_speed_default()``` - Reset the speed of the breathing effect to the default value.
944 The following example shows how to enable the backlight breathing effect when the FUNCTION layer macro button is pressed:
947 if (record->event.pressed)
949 breathing_speed_set(3);
951 layer_on(LAYER_FUNCTION);
955 breathing_speed_set(1);
956 breathing_self_disable();
957 layer_off(LAYER_FUNCTION);
961 The following example shows how to pulse the backlight on-off-on when the RAISED layer macro button is pressed:
964 if (record->event.pressed)
966 layer_on(LAYER_RAISED);
967 breathing_speed_set(2);
969 update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
973 layer_off(LAYER_RAISED);
974 update_tri_layer(LAYER_LOWER, LAYER_RAISED, LAYER_ADJUST);
978 ## Other firmware shortcut keycodes
980 * `RESET` - puts the MCU in DFU mode for flashing new firmware (with `make dfu`)
981 * `DEBUG` - the firmware into debug mode - you'll need hid_listen to see things
982 * `BL_ON` - turns the backlight on
983 * `BL_OFF` - turns the backlight off
984 * `BL_<n>` - sets the backlight to level *n*
985 * `BL_INC` - increments the backlight level by one
986 * `BL_DEC` - decrements the backlight level by one
987 * `BL_TOGG` - toggles the backlight
988 * `BL_STEP` - steps through the backlight levels
990 Enable the backlight from the Makefile.
992 # Custom Quantum functions
994 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.
996 ## `void matrix_init_*(void)`
998 This function gets called when the matrix is initiated, and can contain start-up code for your keyboard/keymap.
1000 ## `void matrix_scan_*(void)`
1002 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.
1004 ## `bool process_record_*(uint16_t keycode, keyrecord_t *record)`
1006 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.
1008 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.
1010 The `record` variable contains infomation about the actual press:
1013 keyrecord_t record {
1025 The conditional `if (record->event.pressed)` can tell if the key is being pressed or released, and you can execute code based on that.
1027 ## `void led_set_*(uint8_t usb_led)`
1029 This gets called whenever there is a state change on your host LEDs (eg caps lock, scroll lock, etc). The LEDs are defined as:
1032 #define USB_LED_NUM_LOCK 0
1033 #define USB_LED_CAPS_LOCK 1
1034 #define USB_LED_SCROLL_LOCK 2
1035 #define USB_LED_COMPOSE 3
1036 #define USB_LED_KANA 4
1039 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.
1041 # Modding your keyboard
1043 ## Audio output from a speaker
1045 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 make it beep. You can use those beeps to indicate layer transitions, modifiers, special keys, or just to play some funky 8bit tunes.
1047 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:
1053 Then, lower down the file:
1056 float tone_startup[][2] = {
1065 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.
1067 Then, we have this chunk:
1070 float tone_qwerty[][2] = SONG(QWERTY_SOUND);
1071 float tone_dvorak[][2] = SONG(DVORAK_SOUND);
1072 float tone_colemak[][2] = SONG(COLEMAK_SOUND);
1073 float tone_plover[][2] = SONG(PLOVER_SOUND);
1074 float tone_plover_gb[][2] = SONG(PLOVER_GOODBYE_SOUND);
1076 float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
1077 float goodbye[][2] = SONG(GOODBYE_SOUND);
1080 Wherein we bind predefined songs (from [quantum/audio/song_list.h](/quantum/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.
1082 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:
1085 PLAY_NOTE_ARRAY(tone_plover, false, 0); // Signature is: Song name, repeat, rest style
1088 This is inside one of the macros. So when that macro executes, your keyboard plays that particular chime.
1090 "Rest style" in the method signature above (the last parameter) specifies if there's a rest (a moment of silence) between the notes.
1093 ## Recording And Playing back Music
1094 * ```Music On``` - Turn music mode on. The default mapping is ```Lower+Upper+C```
1095 * ```LCTL``` - start a recording
1097 * ```LALT``` - stop recording, stop playing
1098 * ```LGUI``` - play recording
1099 * ```LALT``` - stop playing
1100 * ```Music Off``` - Turn music mode off. The default mapping is ```Lower+Upper+V```
1103 ## MIDI functionalty
1105 This is still a WIP, but check out `quantum/keymap_midi.c` to see what's happening. Enable from the Makefile.
1107 ## Bluetooth functionality
1109 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.
1111 ## International Characters on Windows
1113 [AutoHotkey](https://autohotkey.com) allows Windows users to create custom hotkeys among others.
1115 The method does not require Unicode support in the keyboard itself but depends instead of AutoHotkey running in the background.
1117 First you need to select a modifier combination that is not in use by any of your programs.
1118 CtrlAltWin is not used very widely and should therefore be perfect for this.
1119 There is a macro defined for a mod-tab combo `LCAG_T`.
1120 Add this mod-tab combo to a key on your keyboard, e.g.: `LCAG_T(KC_TAB)`.
1121 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.
1123 In the default script of AutoHotkey you can define custom hotkeys.
1128 The hotkeys above are for the combination CtrlAltGui and CtrlAltGuiShift plus the letter a.
1129 AutoHotkey inserts the Text right of `Send, ` when this combination is pressed.
1131 ## RGB Under Glow Mod
1133 
1135 Here is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY).
1137 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.
1139 RGBLIGHT_ENABLE = yes
1141 In order to use the underglow animation functions, you need to have `#define RGBLIGHT_ANIMATIONS` in your `config.h`.
1143 Please add the following options into your config.h, and set them up according your hardware configuration. These settings are for the `F4` pin by default:
1145 #define RGB_DI_PIN F4 // The pin your RGB strip is wired to
1146 #define RGBLIGHT_ANIMATIONS // Require for fancier stuff (not compatible with audio)
1147 #define RGBLED_NUM 14 // Number of LEDs
1148 #define RGBLIGHT_HUE_STEP 10
1149 #define RGBLIGHT_SAT_STEP 17
1150 #define RGBLIGHT_VAL_STEP 17
1152 You'll need to edit `RGB_DI_PIN` to the pin you have your `DI` on your RGB strip wired to.
1154 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`
1158 
1160 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.
1162 ## PS/2 Mouse Support
1164 Its possible to hook up a PS/2 mouse (for example touchpads or trackpoints) to your keyboard as a composite device.
1166 There are three available modes for hooking up PS/2 devices: USART (best), interrupts (better) or busywait (not recommended).
1168 ### Busywait version
1170 Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible.
1175 PS2_MOUSE_ENABLE = yes
1176 PS2_USE_BUSYWAIT = yes
1179 In your keyboard config.h:
1182 #ifdef PS2_USE_BUSYWAIT
1183 # define PS2_CLOCK_PORT PORTD
1184 # define PS2_CLOCK_PIN PIND
1185 # define PS2_CLOCK_DDR DDRD
1186 # define PS2_CLOCK_BIT 1
1187 # define PS2_DATA_PORT PORTD
1188 # define PS2_DATA_PIN PIND
1189 # define PS2_DATA_DDR DDRD
1190 # define PS2_DATA_BIT 2
1194 ### Interrupt version
1196 The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data.
1201 PS2_MOUSE_ENABLE = yes
1205 In your keyboard config.h:
1209 #define PS2_CLOCK_PORT PORTD
1210 #define PS2_CLOCK_PIN PIND
1211 #define PS2_CLOCK_DDR DDRD
1212 #define PS2_CLOCK_BIT 2
1213 #define PS2_DATA_PORT PORTD
1214 #define PS2_DATA_PIN PIND
1215 #define PS2_DATA_DDR DDRD
1216 #define PS2_DATA_BIT 5
1218 #define PS2_INT_INIT() do { \
1219 EICRA |= ((1<<ISC21) | \
1222 #define PS2_INT_ON() do { \
1223 EIMSK |= (1<<INT2); \
1225 #define PS2_INT_OFF() do { \
1226 EIMSK &= ~(1<<INT2); \
1228 #define PS2_INT_VECT INT2_vect
1234 To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version.
1239 PS2_MOUSE_ENABLE = yes
1243 In your keyboard config.h:
1246 #ifdef PS2_USE_USART
1247 #define PS2_CLOCK_PORT PORTD
1248 #define PS2_CLOCK_PIN PIND
1249 #define PS2_CLOCK_DDR DDRD
1250 #define PS2_CLOCK_BIT 5
1251 #define PS2_DATA_PORT PORTD
1252 #define PS2_DATA_PIN PIND
1253 #define PS2_DATA_DDR DDRD
1254 #define PS2_DATA_BIT 2
1256 /* synchronous, odd parity, 1-bit stop, 8-bit data, sample at falling edge */
1257 /* set DDR of CLOCK as input to be slave */
1258 #define PS2_USART_INIT() do { \
1259 PS2_CLOCK_DDR &= ~(1<<PS2_CLOCK_BIT); \
1260 PS2_DATA_DDR &= ~(1<<PS2_DATA_BIT); \
1261 UCSR1C = ((1 << UMSEL10) | \
1270 #define PS2_USART_RX_INT_ON() do { \
1271 UCSR1B = ((1 << RXCIE1) | \
1274 #define PS2_USART_RX_POLL_ON() do { \
1275 UCSR1B = (1 << RXEN1); \
1277 #define PS2_USART_OFF() do { \
1279 UCSR1B &= ~((1 << RXEN1) | \
1282 #define PS2_USART_RX_READY (UCSR1A & (1<<RXC1))
1283 #define PS2_USART_RX_DATA UDR1
1284 #define PS2_USART_ERROR (UCSR1A & ((1<<FE1) | (1<<DOR1) | (1<<UPE1)))
1285 #define PS2_USART_RX_VECT USART1_RX_vect
1291 ### Additional Settings
1293 #### PS/2 mouse features
1295 These enable settings supported by the PS/2 mouse protocol: http://www.computer-engineering.org/ps2mouse/
1298 /* Use remote mode instead of the default stream mode (see link) */
1299 #define PS2_MOUSE_USE_REMOTE_MODE
1301 /* Enable the scrollwheel or scroll gesture on your mouse or touchpad */
1302 #define PS2_MOUSE_ENABLE_SCROLLING
1304 /* Some mice will need a scroll mask to be configured. The default is 0xFF. */
1305 #define PS2_MOUSE_SCROLL_MASK 0x0F
1307 /* Applies a transformation to the movement before sending to the host (see link) */
1308 #define PS2_MOUSE_USE_2_1_SCALING
1310 /* The time to wait after initializing the ps2 host */
1311 #define PS2_MOUSE_INIT_DELAY 1000 /* Default */
1314 You can also call the following functions from ps2_mouse.h
1317 void ps2_mouse_disable_data_reporting(void);
1319 void ps2_mouse_enable_data_reporting(void);
1321 void ps2_mouse_set_remote_mode(void);
1323 void ps2_mouse_set_stream_mode(void);
1325 void ps2_mouse_set_scaling_2_1(void);
1327 void ps2_mouse_set_scaling_1_1(void);
1329 void ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution);
1331 void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate);
1336 Use the following defines to change the sensitivity and speed of the mouse.
1337 Note: you can also use `ps2_mouse_set_resolution` for the same effect (not supported on most touchpads).
1340 #define PS2_MOUSE_X_MULTIPLIER 3
1341 #define PS2_MOUSE_Y_MULTIPLIER 3
1342 #define PS2_MOUSE_V_MULTIPLIER 1
1347 If you're using a trackpoint, you will likely want to be able to use it for scrolling.
1348 Its possible to enable a "scroll button/s" that when pressed will cause the mouse to scroll instead of moving.
1349 To enable the feature, you must set a scroll button mask as follows:
1352 #define PS2_MOUSE_SCROLL_BTN_MASK (1<<PS2_MOUSE_BUTTON_MIDDLE) /* Default */
1355 To disable the scroll button feature:
1358 #define PS2_MOUSE_SCROLL_BTN_MASK 0
1361 The available buttons are:
1364 #define PS2_MOUSE_BTN_LEFT 0
1365 #define PS2_MOUSE_BTN_RIGHT 1
1366 #define PS2_MOUSE_BTN_MIDDLE 2
1369 You can also combine buttons in the mask by `|`ing them together.
1371 Once you've configured your scroll button mask, you must configure the scroll button send interval.
1372 This is the interval before which if the scroll buttons were released they would be sent to the host.
1373 After this interval, they will cause the mouse to scroll and will not be sent.
1376 #define PS2_MOUSE_SCROLL_BTN_SEND 300 /* Default */
1379 To disable sending the scroll buttons:
1381 #define PS2_MOUSE_SCROLL_BTN_SEND 0
1384 Fine control over the scrolling is supported with the following defines:
1387 #define PS2_MOUSE_SCROLL_DIVISOR_H 2
1388 #define PS2_MOUSE_SCROLL_DIVISOR_V 2
1393 To debug the mouse, add `debug_mouse = true` or enable via bootmagic.
1396 /* To debug the mouse reports */
1397 #define PS2_MOUSE_DEBUG_HID
1398 #define PS2_MOUSE_DEBUG_RAW
1401 ## Safety Considerations
1403 You probably don't want to "brick" your keyboard, making it impossible
1404 to rewrite firmware onto it. Here are some of the parameters to show
1405 what things are (and likely aren't) too risky.
1407 - If your keyboard map does not include RESET, then, to get into DFU
1408 mode, you will need to press the reset button on the PCB, which
1409 requires unscrewing the bottom.
1410 - Messing with tmk_core / common files might make the keyboard
1412 - Too large a .hex file is trouble; `make dfu` will erase the block,
1413 test the size (oops, wrong order!), which errors out, failing to
1414 flash the keyboard, leaving it in DFU mode.
1415 - To this end, note that the maximum .hex file size on Planck is
1416 7000h (28672 decimal)
1419 Linking: .build/planck_rev4_cbbrowne.elf [OK]
1420 Creating load file for Flash: .build/planck_rev4_cbbrowne.hex [OK]
1423 text data bss dec hex filename
1424 0 22396 0 22396 577c planck_rev4_cbbrowne.hex
1427 - The above file is of size 22396/577ch, which is less than
1429 - As long as you have a suitable alternative .hex file around, you
1430 can retry, loading that one
1431 - Some of the options you might specify in your keyboard's Makefile
1432 consume extra memory; watch out for BOOTMAGIC_ENABLE,
1433 MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE
1434 - DFU tools do /not/ allow you to write into the bootloader (unless
1435 you throw in extra fruitsalad of options), so there is little risk
1437 - EEPROM has around a 100000 write cycle. You shouldn't rewrite the
1438 firmware repeatedly and continually; that'll burn the EEPROM
1441 # Porting your keyboard to QMK
1443 If your keyboard is running an Atmega chip (atmega32u4 and others), it's pretty easy to get things setup for compiling your own firmware to flash onto your board. There is a `/util/new_project.sh <keyboard>` script to help get you started - you can simply pass your keyboard's name into the script, and all of the necessary files will be created. The components of each are described below.
1445 ## `/keyboards/<keyboard>/config.h`
1447 The `USB Device descriptor parameter` block contains parameters are used to uniquely identify your keyboard, but they don't really matter to the machine.
1449 Your `MATRIX_ROWS` and `MATRIX_COLS` are the numbers of rows and cols in your keyboard matrix - this may be different than the number of actual rows and columns on your keyboard. There are some tricks you can pull to increase the number of keys in a given matrix, but most keyboards are pretty straight-forward.
1451 The `MATRIX_ROW_PINS` and `MATRIX_COL_PINS` are the pins your MCU uses on each row/column. Your schematic (if you have one) will have this information on it, and the values will vary depending on your setup. This is one of the most important things to double-check in getting your keyboard setup correctly.
1453 For the `DIODE_DIRECTION`, most hand-wiring guides will instruct you to wire the diodes in the `COL2ROW` position, but it's possible that they are in the other - people coming from EasyAVR often use `ROW2COL`. Nothing will function if this is incorrect.
1455 `BACKLIGHT_PIN` is the pin that your PWM-controlled backlight (if one exists) is hooked-up to. Currently only B5, B6, and B7 are supported.
1457 `BACKLIGHT_BREATHING` is a fancier backlight feature that adds breathing/pulsing/fading effects to the backlight. It uses the same timer as the normal backlight. These breathing effects must be called by code in your keymap.
1459 `BACKLIGHT_LEVELS` is how many levels exist for your backlight - max is 15, and they are computed automatically from this number.
1461 ## `/keyboards/<keyboard>/Makefile`
1463 The values at the top likely won't need to be changed, since most boards use the `atmega32u4` chip. The `BOOTLOADER_SIZE` will need to be adjusted based on your MCU type. It's defaulted to the Teensy, since that's the most common controller. Below is quoted from the `Makefile`.
1466 # Boot Section Size in *bytes*
1467 # Teensy halfKay 512
1468 # Teensy++ halfKay 1024
1469 # Atmel DFU loader 4096
1470 # LUFA bootloader 4096
1472 OPT_DEFS += -DBOOTLOADER_SIZE=512
1475 At the bottom of the file, you'll find lots of features to turn on and off - all of these options should be set with `?=` to allow for the keymap overrides. `?=` only assigns if the variable was previously undefined. For the full documenation of these features, see the [Makefile options](#makefile-options).
1477 ## `/keyboards/<keyboard>/readme.md`
1479 This is where you'll describe your keyboard - please write as much as you can about it! Talking about default functionality/features is useful here. Feel free to link to external pages/sites if necessary. Images can be included here as well. This file will be rendered into a webpage at qmk.fm/keyboards/<keyboard>/.
1481 ## `/keyboards/<keyboard>/<keyboard>.c`
1483 This is where all of the custom logic for your keyboard goes - you may not need to put anything in this file, since a lot of things are configured automatically. All of the `*_kb()` functions are defined here. If you modify them, remember to keep the calls to `*_user()`, or things in the keymaps might not work. You can read more about the functions [here](#custom-quantum-functions-for-keyboards-and-keymaps)
1485 ## `/keyboards/<keyboard>/<keyboard>.h`
1487 Here is where you can (optionally) define your `KEYMAP` function to remap your matrix into a more readable format. With ortholinear boards, this isn't always necessary, but it can help to accomodate the dead spots on your matrix, where there are keys that take up more than one space (2u, staggering, 6.25u, etc). The example shows the difference between the physical keys, and the matrix design:
1495 { k00, k01, k02 }, \
1496 { k10, KC_NO, k11 }, \
1500 Each of the `kxx` variables needs to be unique, and usually follows the format `k<row><col>`. You can place `KC_NO` where your dead keys are in your matrix.
1504 If you are new to unit testing, then you can find many good resources on internet. However most of it is scattered around in small pieces here and there, and there's also many different opinions, so I won't give any recommendations.
1506 Instead I recommend these two books, explaining two different styles of Unit Testing in detail.
1508 * "Test Driven Development: By Example: Kent Beck"
1509 * "Growing Object-Oriented Software, Guided By Tests: Steve Freeman, Nat Pryce"
1511 If you prefer videos there are Uncle Bob's [Clean Coders Videos](https://cleancoders.com/), which unfortunately cost quite a bit, especially if you want to watch many of them. But James Shore has a free [Let's Play](http://www.jamesshore.com/Blog/Lets-Play) video series.
1513 ## Google Test and Google Mock
1514 It's possible to Unit Test your code using [Google Test](https://github.com/google/googletest). The Google Test framework also includes another component for writing testing mocks and stubs, called "Google Mock". For information how to write the actual tests, please refer to the documentation on that site.
1518 Note that Google Test and therefore any test has to be written in C++, even if the rest of the QMK codebases is written in C. This should hopefully not be a problem even if you don't know any C++, since there's quite clear documentation and examples of the required C++ features, and you can write the rest of the test code almost as you would write normal C. Note that some compiler errors which you might get can look quite scary, but just read carefully what it says, and you should be ok.
1520 One thing to remember, is that you have to append `extern "C"` around all of your C file includes.
1522 ## Adding tests for new or existing features
1524 If you want to unit test some feature, then take a look at the existing serial_link tests, in the `quantum/serial_link/tests folder`, and follow the steps below to create a similar structure.
1526 1. If it doesn't already exist, add a test subfolder to the folder containing the feature.
1527 2. Create a `testlist.mk` and a `rules.mk` file in that folder.
1528 3. Include those files from the root folder `testlist.mk`and `build_test.mk` respectively.
1529 4. Add a new name for your testgroup to the `testlist.mk` file. Each group defined there will be a separate executable. And that's how you can support mocking out different parts. Note that it's worth adding some common prefix, just like it's done for the serial_link tests. The reason for that is that the make command allows substring filtering, so this way you can easily run a subset of the tests.
1530 5. Define the source files and required options in the `rules.mk` file.
1531 * `_SRC` for source files
1532 * `_DEFS` for additional defines
1533 * `_INC` for additional include folders
1534 6. Write the tests in a new cpp file inside the test folder you created. That file has to be one of the files included from the `rules.mk` file.
1536 Note how there's several different tests, each mocking out a separate part. Also note that each of them only compiles the very minimum that's needed for the tests. It's recommend that you try to do the same. For a relevant video check out [Matt Hargett "Advanced Unit Testing in C & C++](https://www.youtube.com/watch?v=Wmy6g-aVgZI)
1538 ## Running the tests
1540 To run all the tests in the codebase, type `make test`. You can also run test matching a substring by typing `make test-matchingsubstring` Note that the tests are always compiled with the native compiler of your platform, so they are also run like any other program on your computer.
1542 ## Debugging the tests
1544 If there are problems with the tests, you can find the executable in the `./build/test` folder. You should be able to run those with GDB or a similar debugger.
1546 ## Full Integration tests
1548 It's not yet possible to do a full integration test, where you would compile the whole firmware and define a keymap that you are going to test. However there are plans for doing that, because writing tests that way would probably be easier, at least for people that are not used to unit testing.
1550 In that model you would emulate the input, and expect a certain output from the emulated keyboard.
1554 Sometimes you might wonder why a variable gets changed and where, and this can be quite tricky to track down without having a debugger. It's of course possible to manually add print statements to track it, but you can also enable the variable trace feature. This works for both for variables that are changed by the code, and when the variable is changed by some memory corruption.
1556 To take the feature into use add `VARIABLE_TRACE=x` to the end of you make command. `x` represents the number of variables you want to trace, which is usually 1.
1558 Then at a suitable place in the code, call `ADD_TRACED_VARIABLE`, to begin the tracing. For example to trace all the layer changes, you can do this
1560 void matrix_init_user(void) {
1561 ADD_TRACED_VARIABLE("layer", &layer_state, sizeof(layer_state));
1565 This will add a traced variable named "layer" (the name is just for your information), which tracks the memory location of `layer_state`. It tracks 4 bytes (the size of `layer_state`), so any modification to the variable will be reported. By default you can not specify a size bigger than 4, but you can change it by adding `MAX_VARIABLE_TRACE_SIZE=x` to the end of the make command line.
1567 In order to actually detect changes to the variables you should call `VERIFY_TRACED_VARIABLES` around the code that you think that modifies the variable. If a variable is modified it will tell you between which two `VERIFY_TRACED_VARIABLES` calls the modification happened. You can then add more calls to track it down further. I don't recommend spamming the codebase with calls. It's better to start with a few, and then keep adding them in a binary search fashion. You can also delete the ones you don't need, as each call need to store the file name and line number in the ROM, so you can run out of memory if you add too many calls.
1569 Also remember to delete all the tracing code once you have found the bug, as you wouldn't want to create a pull request with tracing code.
projects / qmk_firmware.git / blob