aboutsummaryrefslogtreecommitdiff
path: root/docs/custom_quantum_functions.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-06-30 10:06:40 -0700
committerskullY <skullydazed@gmail.com>2017-06-30 10:06:40 -0700
commit486abde026a2e2d44a09477bbeb4ff122c104f1d (patch)
treea2fb93e184a208b58ec877f4f5c281e66a2b9c1f /docs/custom_quantum_functions.md
parentd6d14b67940c8de09a13fee4fe7ff30623d4653e (diff)
downloadqmk_firmware-486abde026a2e2d44a09477bbeb4ff122c104f1d.tar.gz
qmk_firmware-486abde026a2e2d44a09477bbeb4ff122c104f1d.zip
tweak page-toc settings
Diffstat (limited to 'docs/custom_quantum_functions.md')
-rw-r--r--docs/custom_quantum_functions.md26
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/custom_quantum_functions.md b/docs/custom_quantum_functions.md
index 9faac9d7e..17615d991 100644
--- a/docs/custom_quantum_functions.md
+++ b/docs/custom_quantum_functions.md
@@ -16,11 +16,11 @@ Each of the functions described below can be defined with a `_kb()` suffix or a
16 16
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. 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.
18 18
19## Custom Keycodes 19# Custom Keycodes
20 20
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. 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.
22 22
23### Defining a New Keycode 23## Defining a New Keycode
24 24
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. 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.
26 26
@@ -34,13 +34,13 @@ enum my_keycodes {
34}; 34};
35``` 35```
36 36
37### Programming The Behavior Of A Keycode 37## Programming The Behavior Of A Keycode
38 38
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. 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.
40 40
41These function are called every time a key is pressed or released. 41These function are called every time a key is pressed or released.
42 42
43#### Example `process_record_user()` implementation 43### Example `process_record_user()` implementation
44 44
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. 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.
46 46
@@ -64,7 +64,7 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
64} 64}
65``` 65```
66 66
67#### `process_record_*` Function documentation 67### `process_record_*` Function documentation
68 68
69* 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)`
70* Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)` 70* Keymap: `bool process_record_user(uint16_t keycode, keyrecord_t *record)`
@@ -86,7 +86,7 @@ keyrecord_t record {
86} 86}
87``` 87```
88 88
89### LED Control 89## LED Control
90 90
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. 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.
92 92
@@ -96,7 +96,7 @@ This allows you to control the 5 LED's defined as part of the USB Keyboard spec.
96* `USB_LED_COMPOSE` 96* `USB_LED_COMPOSE`
97* `USB_LED_KANA` 97* `USB_LED_KANA`
98 98
99#### Example `led_set_kb()` implementation 99### Example `led_set_kb()` implementation
100 100
101``` 101```
102void led_set_kb(uint8_t usb_led) { 102void led_set_kb(uint8_t usb_led) {
@@ -128,12 +128,12 @@ void led_set_kb(uint8_t usb_led) {
128} 128}
129``` 129```
130 130
131#### `led_set_*` Function documentation 131### `led_set_*` Function documentation
132 132
133* Keyboard/Revision: `void led_set_kb(uint8_t usb_led)` 133* Keyboard/Revision: `void led_set_kb(uint8_t usb_led)`
134* Keymap: `void led_set_user(uint8_t usb_led)` 134* Keymap: `void led_set_user(uint8_t usb_led)`
135 135
136### Matrix Initialization Code 136## Matrix Initialization Code
137 137
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. 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.
139 139
@@ -153,20 +153,20 @@ void matrix_init_kb(void) {
153} 153}
154``` 154```
155 155
156#### `matrix_init_*` Function documentation 156### `matrix_init_*` Function documentation
157 157
158* Keyboard/Revision: `void matrix_init_kb(void)` 158* Keyboard/Revision: `void matrix_init_kb(void)`
159* Keymap: `void matrix_init_user(void)` 159* Keymap: `void matrix_init_user(void)`
160 160
161### Matrix Scanning Code 161## Matrix Scanning Code
162 162
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. 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.
164 164
165#### Example `matrix_scan_*` implementation 165### Example `matrix_scan_*` implementation
166 166
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). 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).
168 168
169#### `matrix_scan_*` Function documentation 169### `matrix_scan_*` Function documentation
170 170
171* Keyboard/Revision: `void matrix_scan_kb(void)` 171* Keyboard/Revision: `void matrix_scan_kb(void)`
172* Keymap: `void matrix_scan_user(void)` 172* Keymap: `void matrix_scan_user(void)`