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 ## The Old Way: `MACRO()` & `action_get_macro`
 150
 151 ?> This is inherited from TMK, and hasn't been updated - it's recommend that you use `SEND_STRING` and `process_record_user` instead.
 152
 153 By default QMK assumes you don't have any macros. To define your macros you create an `action_get_macro()` function. For example:
 154
 155 ```c
 156 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 157     if (record->event.pressed) {
 158         switch(id) {
 159             case 0:
 160                 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
 161             case 1:
 162                 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
 163         }
 164     }
 165     return MACRO_NONE;
 166 };
 167 ```
 168
 169 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:
 170
 171     if (!record->event.pressed) {
 172
 173 ### Macro Commands
 174
 175 A macro can include the following commands:
 176
 177 * I() change interval of stroke in milliseconds.
 178 * D() press key.
 179 * U() release key.
 180 * T() type key(press and release).
 181 * W() wait (milliseconds).
 182 * END end mark.
 183
 184 ### Mapping a Macro to a Key
 185
 186 Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard:
 187
 188 ```c
 189 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 190     [0] = KEYMAP(
 191         M(0), M(1)
 192     ),
 193 };
 194
 195 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 196     if (record->event.pressed) {
 197         switch(id) {
 198             case 0:
 199                 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
 200             case 1:
 201                 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
 202         }
 203     }
 204     return MACRO_NONE;
 205 };
 206 ```
 207
 208 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!".
 209
 210 ### Naming Your Macros
 211
 212 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.
 213
 214 ```c
 215 #define M_HI M(0)
 216 #define M_BYE M(1)
 217
 218 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 219     [0] = KEYMAP(
 220         M_HI, M_BYE
 221     ),
 222 };
 223 ```
 224
 225 ## Advanced Macro Functions
 226
 227 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.
 228
 229 ### `record->event.pressed`
 230
 231 This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
 232
 233 ```c
 234     if (record->event.pressed) {
 235         // on keydown
 236     } else {
 237         // on keyup
 238     }
 239 ```
 240
 241 ### `register_code(<kc>);`
 242
 243 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`.
 244
 245 ### `unregister_code(<kc>);`
 246
 247 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.
 248
 249 ### `tap_code(<kc>);`
 250
 251 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).
 252
 253 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.
 254
 255 ### `clear_keyboard();`
 256
 257 This will clear all mods and keys currently pressed.
 258
 259 ### `clear_mods();`
 260
 261 This will clear all mods currently pressed.
 262
 263 ### `clear_keyboard_but_mods();`
 264
 265 This will clear all keys besides the mods currently pressed.
 266
 267 ## Advanced Example: Single-Key Copy/Paste
 268
 269 This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V` when released.
 270
 271 ```c
 272 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 273     switch(id) {
 274         case 0: {
 275             if (record->event.pressed) {
 276                 return MACRO( D(LCTL), T(C), U(LCTL), END  );
 277             } else {
 278                 return MACRO( D(LCTL), T(V), U(LCTL), END  );
 279             }
 280             break;
 281         }
 282     }
 283     return MACRO_NONE;
 284 };
 285 ```