ref_functions.md (5734B)
1 # List of Useful Core Functions To Make Your Keyboard Better 2 3 There are a lot of hidden functions in QMK that are incredibly useful, or may add a bit of functionality that you've been wanting. Functions that are specific to certain features are not included here, as those will be on their respective feature page. 4 5 ## (OLKB) Tri Layers {#olkb-tri-layers} 6 7 There are actually separate functions that you can use there, depending on what you're after. 8 9 ### `update_tri_layer(x, y, z)` 10 11 The first is the `update_tri_layer(x, y, z)` function. This function check to see if layers `x` and `y` are both on. If they are both on, then it turns on layer `z`. Otherwise, if both `x` and `y` are not both on (either only one is, or neither is), then it turns off layer `z`. 12 13 This function is useful if you want to create specific keys that have this functionality, but other layer keycodes won't do this. 14 15 #### Example 16 17 ```c 18 bool process_record_user(uint16_t keycode, keyrecord_t *record) { 19 switch (keycode) { 20 case LOWER: 21 if (record->event.pressed) { 22 layer_on(_LOWER); 23 update_tri_layer(_LOWER, _RAISE, _ADJUST); 24 } else { 25 layer_off(_LOWER); 26 update_tri_layer(_LOWER, _RAISE, _ADJUST); 27 } 28 return false; 29 case RAISE: 30 if (record->event.pressed) { 31 layer_on(_RAISE); 32 update_tri_layer(_LOWER, _RAISE, _ADJUST); 33 } else { 34 layer_off(_RAISE); 35 update_tri_layer(_LOWER, _RAISE, _ADJUST); 36 } 37 return false; 38 } 39 return true; 40 } 41 ``` 42 43 ### `update_tri_layer_state(state, x, y, z)` 44 The other function is `update_tri_layer_state(state, x, y, z)`. This function is meant to be called from the [`layer_state_set_*` functions](custom_quantum_functions#layer-change-code). This means that any time that you use a keycode to change the layer, this will be checked. So you could use `LT(layer, kc)` to change the layer and it will trigger the same layer check. 45 46 There are a couple of caveats to this method: 47 1. You cannot access the `z` layer without having `x` and `y` layers on, since if you try to activate just layer `z`, it will run this code and turn off layer `z` before you could use it. 48 2. Because layers are processed from the highest number `z` should be a higher layer than `x` and `y` or you may not be able to access it. 49 50 #### Example 51 52 ```c 53 layer_state_t layer_state_set_user(layer_state_t state) { 54 return update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST); 55 } 56 ``` 57 58 Alternatively, you don't have to immediately "return" the value. This is useful if you want to add multiple tri layers, or if you want to add additional effects. 59 60 ```c 61 layer_state_t layer_state_set_user(layer_state_t state) { 62 state = update_tri_layer_state(state, _LOWER, _RAISE, _ADJUST); 63 state = update_tri_layer_state(state, _RAISE, _SYMB, _SPECIAL); 64 return state; 65 } 66 ``` 67 68 ## Setting the Persistent Default Layer 69 70 Do you want to set the default layer, so that it's retained even after you unplug the board? If so, this is the function for you. 71 72 To do this, you would use `set_single_persistent_default_layer(layer)`. If you have a name defined for your layer, you can use that instead (such as _QWERTY, _DVORAK or _COLEMAK). 73 74 This will set the default layer, update the persistent settings, and play a tune if you have [Audio](features/audio) enabled on your board, and the default layer sounds set. 75 76 To configure the default layer sounds, you would want to define this in your `config.h` file, like this: 77 78 ```c 79 #define DEFAULT_LAYER_SONGS { SONG(QWERTY_SOUND), \ 80 SONG(COLEMAK_SOUND), \ 81 SONG(DVORAK_SOUND) \ 82 } 83 ``` 84 85 If you do not require it to be retained after you unplug the board, use `set_single_default_layer(layer)` instead. 86 87 88 ::: tip 89 There are a large number of predefined songs in [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) that you can use. 90 ::: 91 92 ## Resetting the keyboard 93 94 There is the `QK_REBOOT` or `QK_RBT` quantum keycode that you can use. But if you want to reset the board as part of a macro, rather than hitting a key separately, you can do that. 95 96 And to do so, add `soft_reset_keyboard()` to your function or macro. 97 98 ## Reset to bootloader 99 100 To reset to the bootloader use `QK_BOOTLOADER` or `QK_BOOT` keycode or `reset_keyboard()` function. 101 102 ## Wiping the EEPROM (Persistent Storage) 103 104 If you're having issues with Audio, RGB Underglow, backlighting or keys acting weird, then you can reset the EEPROM (persistent setting storage). To force an EEPROM reset, use the [`EE_CLR` keycode](quantum_keycodes) or [Bootmagic](features/bootmagic) functionality. If neither of those are an option, then you can use a custom macro to do so. 105 106 To wipe the EEPROM, run `eeconfig_init()` from your function or macro to reset most of the settings to default. 107 108 ## Tap random key 109 110 If you want to send a random character to the host computer, you can use the `tap_random_base64()` function. This [pseudorandomly](https://en.wikipedia.org/wiki/Pseudorandom_number_generator) selects a number between 0 and 63, and then sends a key press based on that selection. (0–25 is `A`–`Z`, 26–51 is `a`–`z`, 52–61 is `0`–`9`, 62 is `+` and 63 is `/`). 111 112 ::: tip 113 Needless to say, but this is _not_ a cryptographically secure method of generating random Base64 keys or passwords. 114 ::: 115 116 ## Software Timers 117 118 It's possible to start timers and read values for time-specific events. Here's an example: 119 120 ```c 121 static uint16_t key_timer; 122 key_timer = timer_read(); 123 124 if (timer_elapsed(key_timer) < 100) { 125 // do something if less than 100ms have passed 126 } else { 127 // do something if 100ms or more have passed 128 } 129 ```