mirrors/opensteno_qmk
1
0
Fork 0
mirror of https://github.com/openstenoproject/qmk synced 2024-11-12 03:24:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix macro docs to be consistent with keyboard template (#4600)

Browse source
This commit is contained in:
Drashna Jaelre 2018-12-11 09:11:35 -08:00 committed by MechMerlin
parent 930e1dfc4c
commit fb900e2ad1
1 changed files with 88 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

158
docs/feature_macros.md
View file

@ -12,24 +12,28 @@ Here is an example `keymap.c` for a two-key keyboard:
```c ```c
enum custom_keycodes { enum custom_keycodes {
MY_CUSTOM_MACRO = SAFE_RANGE QMKBEST = SAFE_RANGE,
}; };
bool process_record_user(uint16_t keycode, keyrecord_t *record) { bool process_record_user(uint16_t keycode, keyrecord_t *record) {
if (record->event.pressed) { switch (keycode) {
switch(keycode) { case QMKBEST:
case MY_CUSTOM_MACRO: if (record->event.pressed) {
SEND_STRING("QMK is the best thing ever!"); // this is our macro! // when keycode QMKBEST is pressed
return false; SEND_STRING("QMK is the best thing ever!");
} } else {
} // when keycode QMKBEST is released
return true; }
break;
}
return true;
}; };
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = { [0] = {
{MY_CUSTOM_MACRO, KC_ESC} {QMKBEST, KC_ESC}
} }
}; };
``` ```
@ -37,7 +41,7 @@ What happens here is this:
We first define a new custom keycode in the range not occupied by any other keycodes. We first define a new custom keycode in the range not occupied by any other keycodes.
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. 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.
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). 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).
We return `false` to indicate to the caller that the key press we just processed need not be processed any further. 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).
Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button. Finally, we define the keymap so that the first button activates our macro and the second button is just an escape button.
You might want to add more than one macro. You might want to add more than one macro.
@ -45,28 +49,42 @@ You can do that by adding another keycode and adding another case to the switch
```c ```c
enum custom_keycodes { enum custom_keycodes {
MY_CUSTOM_MACRO = SAFE_RANGE, QMKBEST = SAFE_RANGE,
MY_OTHER_MACRO QMKURL,
MY_OTHER_MACRO
}; };
bool process_record_user(uint16_t keycode, keyrecord_t *record) { bool process_record_user(uint16_t keycode, keyrecord_t *record) {
if (record->event.pressed) { switch (keycode) {
switch(keycode) { case QMKBEST:
case MY_CUSTOM_MACRO: if (record->event.pressed) {
SEND_STRING("QMK is the best thing ever!"); // when keycode QMKBEST is pressed
return false; SEND_STRING("QMK is the best thing ever!");
case MY_OTHER_MACRO: } else {
SEND_STRING(SS_LCTRL("ac")); // selects all and copies // when keycode QMKBEST is released
return false; }
} break;
} case QMKURL:
return true; if (record->event.pressed) {
// when keycode QMKURL is pressed
SEND_STRING("https://qmk.fm/" SS_TAP(X_ENTER));
} else {
// when keycode QMKURL is released
}
break;
case MY_OTHER_MACRO:
if (record->event.pressed) {
SEND_STRING(SS_LCTRL("ac")); // selects all and copies
}
break;
}
return true;
}; };
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = { [0] = {
{MY_CUSTOM_MACRO, MY_OTHER_MACRO} {MY_CUSTOM_MACRO, MY_OTHER_MACRO}
} }
}; };
``` ```
@ -136,21 +154,21 @@ By default QMK assumes you don't have any macros. To define your macros you crea
```c ```c
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) { const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
if (record->event.pressed) { if (record->event.pressed) {
switch(id) { switch(id) {
case 0: case 0:
return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END); return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
case 1: case 1:
return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END); return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
} }
} }
return MACRO_NONE; return MACRO_NONE;
}; };
``` ```
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: 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:
if (!record->event.pressed) { if (!record->event.pressed) {
### Macro Commands ### Macro Commands
@ -169,21 +187,21 @@ Use the `M()` function within your `KEYMAP()` to call a macro. For example, here
```c ```c
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = KEYMAP( [0] = KEYMAP(
M(0), M(1) M(0), M(1)
), ),
}; };
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) { const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
if (record->event.pressed) { if (record->event.pressed) {
switch(id) { switch(id) {
case 0: case 0:
return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END); return MACRO(D(LSFT), T(H), U(LSFT), T(I), D(LSFT), T(1), U(LSFT), END);
case 1: case 1:
return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END); return MACRO(D(LSFT), T(B), U(LSFT), T(Y), T(E), D(LSFT), T(1), U(LSFT), END);
} }
} }
return MACRO_NONE; return MACRO_NONE;
}; };
``` ```
@ -198,9 +216,9 @@ If you have a bunch of macros you want to refer to from your keymap while keepin
#define M_BYE M(1) #define M_BYE M(1)
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = KEYMAP( [0] = KEYMAP(
M_HI, M_BYE M_HI, M_BYE
), ),
}; };
``` ```
@ -213,11 +231,11 @@ There are some functions you may find useful in macro-writing. Keep in mind that
This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is This is a boolean value that can be tested to see if the switch is being pressed or released. An example of this is
```c ```c
if (record->event.pressed) { if (record->event.pressed) {
// on keydown // on keydown
} else { } else {
// on keyup // on keyup
} }
``` ```
### `register_code(<kc>);` ### `register_code(<kc>);`
@ -250,16 +268,16 @@ This example defines a macro which sends `Ctrl-C` when pressed down, and `Ctrl-V
```c ```c
const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) { const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
switch(id) { switch(id) {
case 0: { case 0: {
if (record->event.pressed) { if (record->event.pressed) {
return MACRO( D(LCTL), T(C), U(LCTL), END ); return MACRO( D(LCTL), T(C), U(LCTL), END );
} else { } else {
return MACRO( D(LCTL), T(V), U(LCTL), END ); return MACRO( D(LCTL), T(V), U(LCTL), END );
} }
break; break;
} }
} }
return MACRO_NONE; return MACRO_NONE;
}; };
``` ```