1 # Macros - Send multiple keystrokes when pressing just one key
3 QMK has a number of ways to define and use macros. These can do anything you want- type common phrases for you, copypasta, repetitive game movements, or even help you code.
5 **Security Note**: While it is possible to use macros to send passwords, credit card numbers, and other sensitive information it is a supremely bad idea to do so. Anyone who gets ahold of your keyboard will be able to access that information by opening a text editor.
9 By default QMK assumes you don't have any macros. To define your macros you create an `action_get_macro()` function. For example:
12 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
13 if (record->event.pressed) {
16 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
18 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
25 This defines two macros which will be run when the key they are assigned to is pressed. If you'd like them to run when the release is released instead you can change the if statement:
28 if (!record->event.pressed) {
33 A macro can include the following commands:
35 * I() change interval of stroke in milliseconds.
38 * T() type key(press and release).
39 * W() wait (milliseconds).
44 Sometimes you just want a key to type out words or phrases. For the most common situations we've provided `SEND_STRING()`, which will type out your string for you instead of having to build a `MACRO()`. Right now it assumes a US keymap with a QWERTY layout, so if you are using something else it may not behave as you expect.
49 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
50 if (record->event.pressed) {
53 SEND_STRING("QMK is the best thing ever!");
61 ## Mapping a Macro to a key
63 Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard:
66 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
72 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
73 if (record->event.pressed) {
76 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
78 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
85 When you press the key on the left it will type "Hi!" and when you press the key on the right it will type "Bye!".
89 If you have a bunch of macros you want to refer to from your keymap while keeping the keymap easily readable you can name them using `#define` at the top of your file.
95 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
102 # Advanced macro functions
104 While working within the `action_get_macro()` function block there are some functions you may find useful. Keep in mind that while you can write some fairly advanced code within a macro if your functionality gets too complex you may want to define a custom keycode instead. Macros are meant to be simple.
106 #### `record->event.pressed`
108 This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
111 if (record->event.pressed) {
118 #### `register_code(<kc>);`
120 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`.
122 #### `unregister_code(<kc>);`
124 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.
126 #### `clear_keyboard();`
128 This will clear all mods and keys currently pressed.
132 This will clear all mods currently pressed.
134 #### `clear_keyboard_but_mods();`
136 This will clear all keys besides the mods currently pressed.
138 # Advanced Example: Single-key copy/paste (hold to copy, tap to paste)
140 This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V` when released.
143 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
146 if (record->event.pressed) {
147 return MACRO( D(LCTL), T(C), U(LCTL), END );
149 return MACRO( D(LCTL), T(V), U(LCTL), END );