diff options
Diffstat (limited to 'docs/custom_quantum_functions.md')
| -rw-r--r-- | docs/custom_quantum_functions.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md index dabb3fc681..6e869b732c 100644 --- a/docs/custom_quantum_functions.md +++ b/docs/custom_quantum_functions.md @@ -1,4 +1,4 @@ -# How To Customize Your Keyboard's Behavior +# How to Customize Your Keyboard's Behavior For a lot of people a custom keyboard is about more than sending button presses to your computer. You want to be able to do things that are more complex than simple button presses and macros. QMK has hooks that allow you to inject code, override functionality, and otherwise customize how your keyboard behaves in different situations. @@ -34,13 +34,13 @@ enum my_keycodes { }; ``` -## Programming The Behavior Of Any Keycode +## Programming the Behavior of Any Keycode When you want to override the behavior of an existing key, or define the behavior for a new key, you should use the `process_record_kb()` and `process_record_user()` functions. These are called by QMK during key processing before the actual key event is handled. If these functions return `true` QMK will process the keycodes as usual. That can be handy for extending the functionality of a key rather than replacing it. If these functions return `false` QMK will skip the normal key handling, and it will be up you to send any key up or down events that are required. These function are called every time a key is pressed or released. -### Example `process_record_user()` implementation +### Example `process_record_user()` Implementation This example does two things. It defines the behavior for a custom keycode called `FOO`, and it supplements our Enter key by playing a tone whenever it is pressed. @@ -64,7 +64,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { } ``` -### `process_record_*` Function documentation +### `process_record_*` Function Documentation * Keyboard/Revision: `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` * Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)` @@ -96,7 +96,7 @@ This allows you to control the 5 LED's defined as part of the USB Keyboard spec. * `USB_LED_COMPOSE` * `USB_LED_KANA` -### Example `led_set_kb()` implementation +### Example `led_set_kb()` Implementation ``` void led_set_kb(uint8_t usb_led) { @@ -128,7 +128,7 @@ void led_set_kb(uint8_t usb_led) { } ``` -### `led_set_*` Function documentation +### `led_set_*` Function Documentation * Keyboard/Revision: `void led_set_kb(uint8_t usb_led)` * Keymap: `void led_set_user(uint8_t usb_led)` @@ -137,7 +137,7 @@ void led_set_kb(uint8_t usb_led) { Before a keyboard can be used the hardware must be initialized. QMK handles initialization of the keyboard matrix itself, but if you have other hardware like LED's or i²c controllers you will need to set up that hardware before it can be used. -### Example `matrix_init_kb()` implementation +### Example `matrix_init_kb()` Implementation This example, at the keyboard level, sets up B1, B2, and B3 as LED pins. @@ -153,7 +153,7 @@ void matrix_init_kb(void) { } ``` -### `matrix_init_*` Function documentation +### `matrix_init_*` Function Documentation * Keyboard/Revision: `void matrix_init_kb(void)` * Keymap: `void matrix_init_user(void)` @@ -162,11 +162,11 @@ void matrix_init_kb(void) { Whenever possible you should customize your keyboard by using `process_record_*()` and hooking into events that way, to ensure that your code does not have a negative performance impact on your keyboard. However, in rare cases it is necessary to hook into the matrix scanning. Be extremely careful with the performance of code in these functions, as it will be called at least 10 times per second. -### Example `matrix_scan_*` implementation +### Example `matrix_scan_*` Implementation This example has been deliberately omitted. You should understand enough about QMK internals to write this without an example before hooking into such a performance sensitive area. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on gitter](https://gitter.im/qmk/qmk_firmware). -### `matrix_scan_*` Function documentation +### `matrix_scan_*` Function Documentation * Keyboard/Revision: `void matrix_scan_kb(void)` * Keymap: `void matrix_scan_user(void)` |