aboutsummaryrefslogtreecommitdiff
path: root/docs/custom_quantum_functions.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-06-30 09:42:38 -0700
committerskullY <skullydazed@gmail.com>2017-06-30 09:42:38 -0700
commit10b389f79c55d675fb52318d7574ddd65c1447a0 (patch)
tree9a0ed8a112c67ccf0bdd622fdaa10c2bd488c51b /docs/custom_quantum_functions.md
parent77ab0f16a0a72a1e9b2b4c82a01773c9270ce82d (diff)
downloadqmk_firmware-10b389f79c55d675fb52318d7574ddd65c1447a0.tar.gz
qmk_firmware-10b389f79c55d675fb52318d7574ddd65c1447a0.zip
Adjust headings to make navigator happier
Diffstat (limited to 'docs/custom_quantum_functions.md')
-rw-r--r--docs/custom_quantum_functions.md32
1 files changed, 14 insertions, 18 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md
index ede0aebfc..9faac9d7e 100644
--- a/docs/custom_quantum_functions.md
+++ b/docs/custom_quantum_functions.md
@@ -1,7 +1,5 @@
1# How To Customize Your Keyboard's Behavior 1# How To Customize Your Keyboard's Behavior
2 2
3<!-- toc -->
4
5For 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. 3For 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.
6 4
7This page does not assume any special knowledge about QMK, but reading [Understanding QMK](understanding_qmk.html) will help you understand what is going on at a more fundamental level. 5This page does not assume any special knowledge about QMK, but reading [Understanding QMK](understanding_qmk.html) will help you understand what is going on at a more fundamental level.
@@ -18,11 +16,11 @@ Each of the functions described below can be defined with a `_kb()` suffix or a
18 16
19When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `_user()` before executing anything else- otherwise the keymap level function will never be called. 17When defining functions at the Keyboard/Revision level it is important that your `_kb()` implementation call `_user()` before executing anything else- otherwise the keymap level function will never be called.
20 18
21# Custom Keycodes 19## Custom Keycodes
22 20
23By far the most common task is to change the behavior of an existing keycode or to create a new keycode. From a code standpoint the mechanism for each is very similar. 21By far the most common task is to change the behavior of an existing keycode or to create a new keycode. From a code standpoint the mechanism for each is very similar.
24 22
25## Defining a New Keycode 23### Defining a New Keycode
26 24
27The first step to creating your own custom keycode(s) is to enumerate them. This means both naming them and assigning a unique number to that keycode. Rather than limit custom keycodes to a fixed range of numbers QMK provides the `SAFE_RANGE` macro. You can use `SAFE_RANGE` when enumerating your custom keycodes to guarantee that you get a unique number. 25The first step to creating your own custom keycode(s) is to enumerate them. This means both naming them and assigning a unique number to that keycode. Rather than limit custom keycodes to a fixed range of numbers QMK provides the `SAFE_RANGE` macro. You can use `SAFE_RANGE` when enumerating your custom keycodes to guarantee that you get a unique number.
28 26
@@ -36,13 +34,13 @@ enum my_keycodes {
36}; 34};
37``` 35```
38 36
39## Programming The Behavior Of A Keycode 37### Programming The Behavior Of A Keycode
40 38
41When 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,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 and key up or down events that are required. 39When 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,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 and key up or down events that are required.
42 40
43These function are called every time a key is pressed or released. 41These function are called every time a key is pressed or released.
44 42
45### Example `process_record_user()` implementation 43#### Example `process_record_user()` implementation
46 44
47This 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. 45This 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.
48 46
@@ -66,7 +64,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
66} 64}
67``` 65```
68 66
69### `process_record_*` Function documentation 67#### `process_record_*` Function documentation
70 68
71* Keyboard/Revision: `bool process_record_kb(uint16_t keycode, keyrecord_t *record)` 69* Keyboard/Revision: `bool process_record_kb(uint16_t keycode, keyrecord_t *record)`
72* Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)` 70* Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)`
@@ -88,7 +86,7 @@ keyrecord_t record {
88} 86}
89``` 87```
90 88
91## LED Control 89### LED Control
92 90
93This allows you to control the 5 LED's defined as part of the USB Keyboard spec. It will be called when the state of one of those 5 LEDs changes. 91This allows you to control the 5 LED's defined as part of the USB Keyboard spec. It will be called when the state of one of those 5 LEDs changes.
94 92
@@ -98,7 +96,7 @@ This allows you to control the 5 LED's defined as part of the USB Keyboard spec.
98* `USB_LED_COMPOSE` 96* `USB_LED_COMPOSE`
99* `USB_LED_KANA` 97* `USB_LED_KANA`
100 98
101### Example `led_set_kb()` implementation 99#### Example `led_set_kb()` implementation
102 100
103``` 101```
104void led_set_kb(uint8_t usb_led) { 102void led_set_kb(uint8_t usb_led) {
@@ -130,16 +128,16 @@ void led_set_kb(uint8_t usb_led) {
130} 128}
131``` 129```
132 130
133### `led_set_*` Function documentation 131#### `led_set_*` Function documentation
134 132
135* Keyboard/Revision: `void led_set_kb(uint8_t usb_led)` 133* Keyboard/Revision: `void led_set_kb(uint8_t usb_led)`
136* Keymap: `void led_set_user(uint8_t usb_led)` 134* Keymap: `void led_set_user(uint8_t usb_led)`
137 135
138## Matrix Initialization Code 136### Matrix Initialization Code
139 137
140Before 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&#xb2;c controllers you will need to set up that hardware before it can be used. 138Before 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&#xb2;c controllers you will need to set up that hardware before it can be used.
141 139
142### Example `matrix_init_kb()` implementation 140#### Example `matrix_init_kb()` implementation
143 141
144This example, at the keyboard level, sets up B1, B2, and B3 as LED pins. 142This example, at the keyboard level, sets up B1, B2, and B3 as LED pins.
145 143
@@ -155,20 +153,20 @@ void matrix_init_kb(void) {
155} 153}
156``` 154```
157 155
158### `matrix_init_*` Function documentation 156#### `matrix_init_*` Function documentation
159 157
160* Keyboard/Revision: `void matrix_init_kb(void)` 158* Keyboard/Revision: `void matrix_init_kb(void)`
161* Keymap: `void matrix_init_user(void)` 159* Keymap: `void matrix_init_user(void)`
162 160
163## Matrix Scanning Code 161### Matrix Scanning Code
164 162
165Whenever 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. 163Whenever 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.
166 164
167### Example `matrix_scan_*` implementation 165#### Example `matrix_scan_*` implementation
168 166
169This 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). 167This 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).
170 168
171### `matrix_scan_*` Function documentation 169#### `matrix_scan_*` Function documentation
172 170
173* Keyboard/Revision: `void matrix_scan_kb(void)` 171* Keyboard/Revision: `void matrix_scan_kb(void)`
174* Keymap: `void matrix_scan_user(void)` 172* Keymap: `void matrix_scan_user(void)`
@@ -176,5 +174,3 @@ This example has been deliberately omitted. You should understand enough about Q
176This function gets called at every matrix scan, which is basically as often as the MCU can handle. Be careful what you put here, as it will get run a lot. 174This function gets called at every matrix scan, which is basically as often as the MCU can handle. Be careful what you put here, as it will get run a lot.
177 175
178You should use this function if you need custom matrix scanning code. It can also be used for custom status output (such as LED's or a display) or other functionality that you want to trigger regularly even when the user isn't typing. 176You should use this function if you need custom matrix scanning code. It can also be used for custom status output (such as LED's or a display) or other functionality that you want to trigger regularly even when the user isn't typing.
179
180