docs/macros.md

   1 # Macros - Send multiple keystrokes when pressing just one key
   2
   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.
   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 ahold of your keyboard will be able to access that information by opening a text editor.
   6
   7 # Macro Definitions
   8
   9 By default QMK assumes you don't have any macros. To define your macros you create an `action_get_macro()` function. For example:
  10
  11 ```c
  12 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
  13         if (record->event.pressed) {
  14                 switch(id) {
  15                         case 0:
  16                                 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
  17                         case 1:
  18                                 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
  19                 }
  20         }
  21         return MACRO_NONE;
  22 };
  23 ```
  24
  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:
  26
  27 ```c
  28         if (!record->event.pressed) {
  29 ```
  30
  31 ## Macro Commands
  32
  33 A macro can include the following commands:
  34
  35 * I() change interval of stroke in milliseconds.
  36 * D() press key.
  37 * U() release key.
  38 * T() type key(press and release).
  39 * W() wait (milliseconds).
  40 * END end mark.
  41
  42 ## Sending strings
  43
  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()`.
  45
  46 For example:
  47
  48 ```c
  49 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
  50         if (record->event.pressed) {
  51                 switch(id) {
  52                         case 0:
  53                                 SEND_STRING("QMK is the best thing ever!");
  54                                 return false;
  55                 }
  56         }
  57         return MACRO_NONE;
  58 };
  59 ```
  60
  61 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:
  62
  63 ```
  64 #include <sendstring_colemak.h>
  65 ```
  66
  67 ## Mapping a Macro to a key
  68
  69 Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard:
  70
  71 ```c
  72 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  73         [0] = KEYMAP(
  74                 M(0), M(1)
  75         ),
  76 };
  77
  78 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
  79         if (record->event.pressed) {
  80                 switch(id) {
  81                         case 0:
  82                                 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
  83                         case 1:
  84                                 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
  85                 }
  86         }
  87         return MACRO_NONE;
  88 };
  89 ```
  90
  91 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!".
  92
  93 ## Naming your macros
  94
  95 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.
  96
  97 ```c
  98 #define M_HI M(0)
  99 #define M_BYE M(1)
 100
 101 const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 102         [0] = KEYMAP(
 103                 M_HI, M_BYE
 104         ),
 105 };
 106 ```
 107
 108 # Advanced macro functions
 109
 110 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.
 111
 112 #### `record->event.pressed`
 113
 114 This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
 115
 116 ```c
 117         if (record->event.pressed) {
 118                 // on keydown
 119         } else {
 120                 // on keyup
 121         }
 122 ```
 123
 124 #### `register_code(<kc>);`
 125
 126 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`.
 127
 128 #### `unregister_code(<kc>);`
 129
 130 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.
 131
 132 #### `clear_keyboard();`
 133
 134 This will clear all mods and keys currently pressed.
 135
 136 #### `clear_mods();`
 137
 138 This will clear all mods currently pressed.
 139
 140 #### `clear_keyboard_but_mods();`
 141
 142 This will clear all keys besides the mods currently pressed.
 143
 144 # Advanced Example: Single-key copy/paste (hold to copy, tap to paste)
 145
 146 This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V` when released.
 147
 148 ```c
 149 const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
 150         switch(id) {
 151                 case 0: {
 152                         if (record->event.pressed) {
 153                                 return MACRO( D(LCTL), T(C), U(LCTL), END  );
 154                         } else {
 155                                 return MACRO( D(LCTL), T(V), U(LCTL), END  );
 156                         }
 157                         break;
 158                 }
 159         }
 160         return MACRO_NONE;
 161 };
 162 ```
 163
 164