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 {% hint style='danger' %}
   6 **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.
   7 {% endhint %}
   8
   9 ## The New Way: `SEND_STRING()` & `process_record_user`
  10
  11 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`).
  12
  13 Here is an example `keymap.c` for a two-key keyboard:
  14
  15 ```c
  16 enum custom_keycodes {
  17         MY_CUSTOM_MACRO = SAFE_RANGE
  18 };
  19
  20 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  21         if (record->event.pressed) {
  22                 switch(keycode) {
  23                         case MY_CUSTOM_MACRO:
  24                                 SEND_STRING("QMK is the best thing ever!"); // this is our macro!
  25                                 return false; break;
  26                 }
  27         }
  28         return true;
  29 };
  30
  31 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  32         [0] = {
  33           {MY_CUSTOM_MACRO, KC_ESC}
  34         }
  35 };
  36 ```
  37
  38 What happens here is this:
  39 We first define a new custom keycode in the range not occupied by any other keycodes.
  40 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.
  41 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).
  42 We return `false` to indicate to the caller that the key press we just processed need not be processed any further.
  43 Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button.
  44
  45 You might want to add more than one macro.
  46 You can do that by adding another keycode and adding another case to the switch statement, like so:
  47
  48 ```c
  49 enum custom_keycodes {
  50         MY_CUSTOM_MACRO = SAFE_RANGE,
  51         MY_OTHER_MACRO
  52 };
  53
  54 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  55         if (record->event.pressed) {
  56                 switch(keycode) {
  57                         case MY_CUSTOM_MACRO:
  58                                 SEND_STRING("QMK is the best thing ever!");
  59                                 return false; break;
  60                         case MY_OTHER_MACRO:
  61                                 SEND_STRING(SS_LCTRL("ac")); // selects all and copies
  62                                 return false; break;
  63                 }
  64         }
  65         return true;
  66 };
  67
  68 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  69         [0] = {
  70           {MY_CUSTOM_MACRO, MY_OTHER_MACRO}
  71         }
  72 };
  73 ```
  74
  75 ### TAP, DOWN and UP
  76
  77 You may want to use keys in your macros that you can't write down, such as `Ctrl` or `Home`.
  78 You can send arbitrary keycodes by wrapping them in:
  79
  80 * `SS_TAP()` presses and releases a key.
  81 * `SS_DOWN()` presses (but does not release) a key.
  82 * `SS_UP()` releases a key.
  83
  84 For example:
  85
  86     SEND_STRING(SS_TAP(X_HOME));
  87
  88 Would tap `KC_HOME` - note how the prefix is now `X_`, and not `KC_`. You can also combine this with other strings, like this:
  89
  90     SEND_STRING("VE"SS_TAP(X_HOME)"LO");
  91
  92 Which would send "VE" followed by a `KC_HOME` tap, and "LO" (spelling "LOVE" if on a newline).
  93
  94 There's also a couple of mod shortcuts you can use:
  95
  96 * `SS_LCTRL(string)`
  97 * `SS_LGUI(string)`
  98 * `SS_LALT(string)`
  99 * `SS_LSFT(string)`
 100
 101 These press the respective modifier, send the supplied string and then release the modifier.
 102 They can be used like this:
 103
 104     SEND_STRING(SS_LCTRL("a"));
 105
 106 Which would send LCTRL+a (LCTRL down, a, LCTRL up) - notice that they take strings (eg `"k"`), and not the `X_K` keycodes.
 107
 108 ### Alternative Keymaps
 109
 110 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:
 111
 112     #include <sendstring_colemak.h>
 113
 114 ### Strings in Memory
 115
 116 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:
 117
 118 ```c
 119 char my_str[4] = "ok.";
 120 send_string(my_str);
 121 ```
 122
 123 The shortcuts defined above won't work with `send_string()`, but you can separate things out to different lines if needed:
 124
 125 ```c
 126 char my_str[4] = "ok.";
 127 SEND_STRING("I said: ");
 128 send_string(my_str);
 129 SEND_STRING(".."SS_TAP(X_END));
 130 ```
 131
 132 ## The Old Way: `MACRO()` & `action_get_macro`
 133
 134 {% hint style='info' %}
 135 This is inherited from TMK, and hasn't been updated - it's recommend that you use `SEND_STRING` and `process_record_user` instead.
 136 {% endhint %}
 137
 138 By default QMK assumes you don't have any macros. To define your macros you create an `action_get_macro()` function. For example:
 139
 140 ```c
 141 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 142         if (record->event.pressed) {
 143                 switch(id) {
 144                         case 0:
 145                                 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
 146                         case 1:
 147                                 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
 148                 }
 149         }
 150         return MACRO_NONE;
 151 };
 152 ```
 153
 154 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:
 155
 156         if (!record->event.pressed) {
 157
 158 ### Macro Commands
 159
 160 A macro can include the following commands:
 161
 162 * I() change interval of stroke in milliseconds.
 163 * D() press key.
 164 * U() release key.
 165 * T() type key(press and release).
 166 * W() wait (milliseconds).
 167 * END end mark.
 168
 169 ### Mapping a Macro to a Key
 170
 171 Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard:
 172
 173 ```c
 174 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 175         [0] = KEYMAP(
 176                 M(0), M(1)
 177         ),
 178 };
 179
 180 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 181         if (record->event.pressed) {
 182                 switch(id) {
 183                         case 0:
 184                                 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
 185                         case 1:
 186                                 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
 187                 }
 188         }
 189         return MACRO_NONE;
 190 };
 191 ```
 192
 193 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!".
 194
 195 ### Naming Your Macros
 196
 197 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.
 198
 199 ```c
 200 #define M_HI M(0)
 201 #define M_BYE M(1)
 202
 203 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 204         [0] = KEYMAP(
 205                 M_HI, M_BYE
 206         ),
 207 };
 208 ```
 209
 210 ## Advanced Macro Functions
 211
 212 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.
 213
 214 ### `record->event.pressed`
 215
 216 This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
 217
 218 ```c
 219         if (record->event.pressed) {
 220                 // on keydown
 221         } else {
 222                 // on keyup
 223         }
 224 ```
 225
 226 ### `register_code(<kc>);`
 227
 228 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`.
 229
 230 ### `unregister_code(<kc>);`
 231
 232 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.
 233
 234 ### `clear_keyboard();`
 235
 236 This will clear all mods and keys currently pressed.
 237
 238 ### `clear_mods();`
 239
 240 This will clear all mods currently pressed.
 241
 242 ### `clear_keyboard_but_mods();`
 243
 244 This will clear all keys besides the mods currently pressed.
 245
 246 ## Advanced Example: Single-Key Copy/Paste
 247
 248 This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V` when released.
 249
 250 ```c
 251 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 252         switch(id) {
 253                 case 0: {
 254                         if (record->event.pressed) {
 255                                 return MACRO( D(LCTL), T(C), U(LCTL), END  );
 256                         } else {
 257                                 return MACRO( D(LCTL), T(V), U(LCTL), END  );
 258                         }
 259                         break;
 260                 }
 261         }
 262         return MACRO_NONE;
 263 };
 264 ```