aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-06-10 15:12:45 -0400
committerGitHub <noreply@github.com>2017-06-10 15:12:45 -0400
commitde4a38ab1be211a50981eb3c67d28ab21f39e882 (patch)
tree771bbe37d1a2a66df6c100aa33e3e8a2a0957e5d
parentceb7a63c6873dcf726032da0be2b5310599a2d51 (diff)
downloadqmk_firmware-de4a38ab1be211a50981eb3c67d28ab21f39e882.tar.gz
qmk_firmware-de4a38ab1be211a50981eb3c67d28ab21f39e882.zip
Delete Macros.md
Diffstat
-rw-r--r--docs/Macros.md158
1 files changed, 0 insertions, 158 deletions
diff --git a/docs/Macros.md b/docs/Macros.md
deleted file mode 100644
index 1418d24ab..000000000
--- a/docs/Macros.md
+++ /dev/null
@@ -1,158 +0,0 @@
1# Macros - Send multiple keystrokes when pressing just one key
2
3QMK 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
9By 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
12const 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
25This 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
33A 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
44Sometimes 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()`. Right now it assumes a US keymap with a QWERTY layout, so if you are using something else it may not behave as you expect.
45
46For example:
47
48```c
49const 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## Mapping a Macro to a key
62
63Use the `M()` function within your `KEYMAP()` to call a macro. For example, here is the keymap for a 2-key keyboard:
64
65```c
66const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
67 [0] = KEYMAP(
68 M(0), M(1)
69 ),
70};
71
72const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
73 if (record->event.pressed) {
74 switch(id) {
75 case 0:
76 return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
77 case 1:
78 return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
79 }
80 }
81 return MACRO_NONE;
82};
83```
84
85When you press the key on the left it will type "Hi!" and when you press the key on the right it will type "Bye!".
86
87## Naming your macros
88
89If 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.
90
91```c
92#define M_HI M(0)
93#define M_BYE M(1)
94
95const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
96 [0] = KEYMAP(
97 M_HI, M_BYE
98 ),
99};
100```
101
102# Advanced macro functions
103
104While 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.
105
106#### `record->event.pressed`
107
108This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
109
110```c
111 if (record->event.pressed) {
112 // on keydown
113 } else {
114 // on keyup
115 }
116```
117
118#### `register_code(<kc>);`
119
120This 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`.
121
122#### `unregister_code(<kc>);`
123
124Parallel 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.
125
126#### `clear_keyboard();`
127
128This will clear all mods and keys currently pressed.
129
130#### `clear_mods();`
131
132This will clear all mods currently pressed.
133
134#### `clear_keyboard_but_mods();`
135
136This will clear all keys besides the mods currently pressed.
137
138# Advanced Example: Single-key copy/paste (hold to copy, tap to paste)
139
140This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V` when released.
141
142```c
143const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
144 switch(id) {
145 case 0: {
146 if (record->event.pressed) {
147 return MACRO( D(LCTL), T(C), U(LCTL), END );
148 } else {
149 return MACRO( D(LCTL), T(V), U(LCTL), END );
150 }
151 break;
152 }
153 }
154 return MACRO_NONE;
155};
156```
157
158
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-04 12:59:19 +0000