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