docs/feature_macros.md

   1 # Macros
   2
   3 Macros allow you to send multiple keystrokes when pressing just one key. 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.
   4
   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 a hold of your keyboard will be able to access that information by opening a text editor.
   6
   7 ## The New Way: `SEND_STRING()` & `process_record_user`
   8
   9 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 (i.e. a sequence of characters) for you. All ASCII characters that are easily translated to a keycode are supported (e.g. `\n\t`).
  10
  11 Here is an example `keymap.c` for a two-key keyboard:
  12
  13 ```c
  14 enum custom_keycodes {
  15   QMKBEST = SAFE_RANGE,
  16 };
  17
  18 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  19   switch (keycode) {
  20     case QMKBEST:
  21       if (record->event.pressed) {
  22         // when keycode QMKBEST is pressed
  23         SEND_STRING("QMK is the best thing ever!");
  24       } else {
  25         // when keycode QMKBEST is released
  26       }
  27       break;
  28
  29   }
  30   return true;
  31 };
  32
  33 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  34   [0] = {
  35     {QMKBEST, KC_ESC}
  36   }
  37 };
  38 ```
  39
  40 What happens here is this:
  41 We first define a new custom keycode in the range not occupied by any other keycodes.
  42 Then we use the `process_record_user` function, which is called whenever a key is pressed or released, to check if our custom keycode has been activated.
  43 If yes, we send the string `"QMK is the best thing ever!"` to the computer via the `SEND_STRING` macro (this is a C preprocessor macro, not to be confused with QMK macros).
  44 We return `true` to indicate to the caller that the key press we just processed should continue to be processed as normal (as we didn't replace or alter the functionality).
  45 Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button.
  46
  47 You might want to add more than one macro.
  48 You can do that by adding another keycode and adding another case to the switch statement, like so:
  49
  50 ```c
  51 enum custom_keycodes {
  52   QMKBEST = SAFE_RANGE,
  53   QMKURL,
  54   MY_OTHER_MACRO
  55 };
  56
  57 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  58   switch (keycode) {
  59     case QMKBEST:
  60       if (record->event.pressed) {
  61         // when keycode QMKBEST is pressed
  62         SEND_STRING("QMK is the best thing ever!");
  63       } else {
  64         // when keycode QMKBEST is released
  65       }
  66       break;
  67     case QMKURL:
  68       if (record->event.pressed) {
  69         // when keycode QMKURL is pressed
  70         SEND_STRING("https://qmk.fm/" SS_TAP(X_ENTER));
  71       } else {
  72         // when keycode QMKURL is released
  73       }
  74       break;
  75     case MY_OTHER_MACRO:
  76       if (record->event.pressed) {
  77                 SEND_STRING(SS_LCTRL("ac")); // selects all and copies
  78       }
  79       break;
  80   }
  81   return true;
  82 };
  83
  84 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  85   [0] = {
  86     {MY_CUSTOM_MACRO, MY_OTHER_MACRO}
  87   }
  88 };
  89 ```
  90
  91 ### TAP, DOWN and UP
  92
  93 You may want to use keys in your macros that you can't write down, such as `Ctrl` or `Home`.
  94 You can send arbitrary keycodes by wrapping them in:
  95
  96 * `SS_TAP()` presses and releases a key.
  97 * `SS_DOWN()` presses (but does not release) a key.
  98 * `SS_UP()` releases a key.
  99
 100 For example:
 101
 102     SEND_STRING(SS_TAP(X_HOME));
 103
 104 Would tap `KC_HOME` - note how the prefix is now `X_`, and not `KC_`. You can also combine this with other strings, like this:
 105
 106     SEND_STRING("VE"SS_TAP(X_HOME)"LO");
 107
 108 Which would send "VE" followed by a `KC_HOME` tap, and "LO" (spelling "LOVE" if on a newline).
 109
 110 There's also a couple of mod shortcuts you can use:
 111
 112 * `SS_LCTRL(string)`
 113 * `SS_LGUI(string)`
 114 * `SS_LALT(string)`
 115 * `SS_LSFT(string)`
 116 * `SS_RALT(string)`
 117
 118 These press the respective modifier, send the supplied string and then release the modifier.
 119 They can be used like this:
 120
 121     SEND_STRING(SS_LCTRL("a"));
 122
 123 Which would send LCTRL+a (LCTRL down, a, LCTRL up) - notice that they take strings (eg `"k"`), and not the `X_K` keycodes.
 124
 125 ### Alternative Keymaps
 126
 127 By default, it assumes a US keymap with a QWERTY layout; if you want to change that (e.g. if your OS uses software Colemak), include this somewhere in your keymap:
 128
 129     #include <sendstring_colemak.h>
 130
 131 ### Strings in Memory
 132
 133 If for some reason you're manipulating strings and need to print out something you just generated (instead of being a literal, constant string), you can use `send_string()`, like this:
 134
 135 ```c
 136 char my_str[4] = "ok.";
 137 send_string(my_str);
 138 ```
 139
 140 The shortcuts defined above won't work with `send_string()`, but you can separate things out to different lines if needed:
 141
 142 ```c
 143 char my_str[4] = "ok.";
 144 SEND_STRING("I said: ");
 145 send_string(my_str);
 146 SEND_STRING(".."SS_TAP(X_END));
 147 ```
 148
 149
 150 ## Advanced Macro Functions
 151
 152 There are some functions you may find useful in macro-writing. 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.
 153
 154 ### `record->event.pressed`
 155
 156 This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
 157
 158 ```c
 159     if (record->event.pressed) {
 160         // on keydown
 161     } else {
 162         // on keyup
 163     }
 164 ```
 165
 166 ### `register_code(<kc>);`
 167
 168 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`.
 169
 170 ### `unregister_code(<kc>);`
 171
 172 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.
 173
 174 ### `tap_code(<kc>);`
 175
 176 This will send `register_code(<kc>)` and then `unregister_code(<kc>)`. This is useful if you want to send both the press and release events ("tap" the key, rather than hold it).
 177
 178 If you're having issues with taps (un)registering, you can add a delay between the register and unregister events by setting `#define TAP_CODE_DELAY 100` in your `config.h` file. The value is in milliseconds.
 179
 180 ### `register_code16(<kc>);`, `unregister_code16(<kc>);` and `tap_code16(<kc>);`
 181
 182 These functions work similar to their regular counterparts, but allow you to use modded keycodes (with Shift, Alt, Control, and/or GUI applied to them).
 183
 184 Eg, you could use `register_code16(S(KC_5));` instead of registering the mod, then registering the keycode.
 185
 186 ### `clear_keyboard();`
 187
 188 This will clear all mods and keys currently pressed.
 189
 190 ### `clear_mods();`
 191
 192 This will clear all mods currently pressed.
 193
 194 ### `clear_keyboard_but_mods();`
 195
 196 This will clear all keys besides the mods currently pressed.
 197
 198 ## Advanced Example:
 199
 200 ### Super ALT↯TAB
 201
 202 This macro will register `KC_LALT` and tap `KC_TAB`, then wait for 1000ms. If the key is tapped again, it will send another `KC_TAB`; if there is no tap, `KC_LALT` will be unregistered, thus allowing you to cycle through windows.
 203
 204 ```c
 205 bool is_alt_tab_active = false;    # ADD this near the begining of keymap.c
 206 uint16_t alt_tab_timer = 0;        # we will be using them soon.
 207
 208 enum custom_keycodes {             # Make sure have the awesome keycode ready
 209   ALT_TAB = SAFE_RANGE,
 210 };
 211
 212 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 213   switch (keycode) {               # This will do most of the grunt work with the keycodes.
 214     case ALT_TAB:
 215       if (record->event.pressed) {
 216         if (!is_alt_tab_active) {
 217           is_alt_tab_active = true;
 218           register_code(KC_LALT);
 219         }
 220         alt_tab_timer = timer_read();
 221         register_code(KC_TAB);
 222       } else {
 223         unregister_code(KC_TAB);
 224       }
 225       break;
 226   }
 227   return true;
 228 }
 229
 230 void matrix_scan_user(void) {     # The very important timer.
 231   if (is_alt_tab_active) {
 232     if (timer_elapsed(alt_tab_timer) > 1000) {
 233       unregister_code(KC_LALT);
 234       is_alt_tab_active = false;
 235     }
 236   }
 237 }
 238 ```
 239
 240 ---
 241
 242 ##  **(DEPRECATED)** The Old Way: `MACRO()` & `action_get_macro`
 243
 244 !> This is inherited from TMK, and hasn't been updated - it's recommended that you use `SEND_STRING` and `process_record_user` instead.
 245
 246 By default QMK assumes you don't have any macros. To define your macros you create an `action_get_macro()` function. For example:
 247
 248 ```c
 249 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 250     if (record->event.pressed) {
 251         switch(id) {
 252             case 0:
 253                 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
 254             case 1:
 255                 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
 256         }
 257     }
 258     return MACRO_NONE;
 259 };
 260 ```
 261
 262 This defines two macros which will be run when the key they are assigned to is pressed. If instead you'd like them to run when the key is released you can change the if statement:
 263
 264     if (!record->event.pressed) {
 265
 266 ### Macro Commands
 267
 268 A macro can include the following commands:
 269
 270 * I() change interval of stroke in milliseconds.
 271 * D() press key.
 272 * U() release key.
 273 * T() type key(press and release).
 274 * W() wait (milliseconds).
 275 * END end mark.
 276
 277 ### Mapping a Macro to a Key
 278
 279 Use the `M()` function within your keymap to call a macro. For example, here is the keymap for a 2-key keyboard:
 280
 281 ```c
 282 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 283     [0] = LAYOUT(
 284         M(0), M(1)
 285     ),
 286 };
 287
 288 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 289     if (record->event.pressed) {
 290         switch(id) {
 291             case 0:
 292                 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
 293             case 1:
 294                 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
 295         }
 296     }
 297     return MACRO_NONE;
 298 };
 299 ```
 300
 301 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!".
 302
 303 ### Naming Your Macros
 304
 305 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.
 306
 307 ```c
 308 #define M_HI M(0)
 309 #define M_BYE M(1)
 310
 311 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 312     [0] = LAYOUT(
 313         M_HI, M_BYE
 314     ),
 315 };
 316 ```
 317
 318
 319 ## Advanced Example:
 320
 321 ### Single-Key Copy/Paste
 322
 323 This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V` when released.
 324
 325 ```c
 326 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 327     switch(id) {
 328         case 0: {
 329             if (record->event.pressed) {
 330                 return MACRO( D(LCTL), T(C), U(LCTL), END  );
 331             } else {
 332                 return MACRO( D(LCTL), T(V), U(LCTL), END  );
 333             }
 334             break;
 335         }
 336     }
 337     return MACRO_NONE;
 338 };
 339 ```